The response envelope

Every response has the same five fields.

The shapejson
{
  "success": true,
  "status": "success",
  "code": 200,
  "message": "OK",
  "data": { }
}
FieldTypeNotes
successbooleantrue or false.
statusstringsuccess or failed. The same fact as success.
codeintegerThe HTTP status, repeated in the body.
messagestringPlain words about what happened.
dataanyThe payload, or null.

Every response also carries an X-Request-Id header. Log it. When you ask us about one call, it is the fastest way for us to find it.

Warning

code is the HTTP status and nothing more. It is not a machine-readable error code, and this API has none. See Errors for what that means for your error handling, because it probably means more work than you expect.

data is null on failure, with one exception

A refusal normally carries no payload:

A plain refusaljson
{
  "success": false,
  "status": "failed",
  "code": 422,
  "message": "disco_code is required.",
  "data": null
}

The exception is a failed order. POST /reseller/orders can answer success: false with the order still in data, because an order that failed is a thing that exists and that you need to see:

A failed orderjson
{
  "success": false,
  "status": "failed",
  "code": 422,
  "message": "The provider refused this meter.",
  "data": {
    "reference": "alpha-0009",
    "state": "refunded",
    "settled": true,
    "amount": 5000
  }
}

Important

If your client treats success: false as "there is no body", it will throw away the one thing that tells you whether the customer's money came back. Read data.state here: refunded means you were not charged in the end, failed means the order did not complete. This is the single most common integration bug against this API.

Lists

A list puts its rows under a named key with a count beside them:

GET /reseller/ordersjson
{
  "success": true,
  "status": "success",
  "code": 200,
  "message": "OK",
  "data": {
    "orders": [],
    "count": 0
  }
}

count is how many rows are in this page, not how many you have in total. There is no total. Page with limit and offset, and stop when a page comes back shorter than the limit you asked for.

Timestamps come in two formats

Both are real and they genuinely differ:

WhereFormatExample
Order placed_at, updated_atUTC, no offset2026-11-18T09:14:22Z
Webhook settled_atRFC 3339 with offset2026-11-18T09:14:37+01:00

A proper RFC 3339 parser reads both. A fixed format string will read one and fail on the other, so do not write one.