Skip to main content

Pagination

List endpoints use offset-based pagination with two query parameters:
ParameterDescriptionDefaultMax
limitNumber of records to return100100
offsetNumber of records to skip0
Every list response includes a meta object with the total count so you can page through results:
{
  "data": [ /* ... */ ],
  "meta": {
    "total": 250,
    "limit": 100,
    "offset": 0
  }
}
To fetch the next page, increase offset by your limit (for example, ?limit=100&offset=100).

Filtering

Some list endpoints accept filters. For example, GET /payments supports recipientId, batchId, and referenceId.

Status codes

The API uses standard HTTP status codes:
StatusMeaning
200Success
201Resource created
400Bad request — validation failed or malformed input
401Unauthorized — missing or invalid API key
404Not found — the resource does not exist
500Internal server error

Errors

Non-success responses return a consistent error envelope:
{
  "error": {
    "message": "amount: amount must be positive",
    "code": "optional_error_code"
  }
}
Validation errors (400) include a human-readable message that names the offending field, making it easy to surface back to your users.