Pagination & errors

Pagination

Paginated list endpoints use offset-based pagination with two query parameters:

Parameter	Description	Default	Max
`limit`	Number of records to return	`100`	`100`
`offset`	Number of records to skip	`0`	—

Every paginated 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).

GET /accounts is not paginated. It returns all eligible payout source accounts in a data array without a meta object.

Filtering

Some list endpoints accept filters. For example, GET /payments supports recipientId, batchId, referenceId, isReimbursement, and sourceAccountId. Account transactions use the same limit, offset, and meta contract, with optional status, startTime, and endTime filters. Keep an explicit endTime and other filters fixed across pages. Changes to pending transactions or late postings can shift offsets; deduplicate by transaction ID and reconcile periodically.

Status codes

The API uses standard HTTP status codes:

Status	Meaning
`200`	Success
`201`	Resource created
`400`	Bad request — validation failed or malformed input
`401`	Unauthorized — missing or invalid API key
`404`	Not found — the resource does not exist
`500`	Internal 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.

Get started

API reference

Filtering

Status codes

Errors

Get started

API reference

​Pagination

​Filtering

​Status codes

​Errors

Pagination

Filtering

Status codes

Errors