Version 2.4.8 · latest

Recharge methods payment-methods

The currently enabled online payment methods, the default method and transfer instructions, used to render the recharge page.

Pick an endpoint to see its example call on the right.

BillingAuthentication: User1 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

Recharge methods object

FieldTypeDescription
default_methodstring Default selected payment method; empty means none.
methodsstring[] Enabled online payment methods.
transferPaymentTransfer Offline transfer settings.
usdt_ratestring Current effective USDT rate: 1 USDT = usdt_rate units of the account currency (same basis as the rate locked at order time); omitted when USDT is off, no rate is set, or the auto rate is stale.

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command