Skip to main content

Amounts

Amounts are whole numbers in the currency’s smallest unit, always with an ISO 4217 currency code. Never send decimals. Every payment shows its fee, fixed when the payment is created:
  • a payin’s net_amount is what you keep: amount minus fee;
  • a payout’s total_debited is what leaves your balance: amount plus fee.

Format

  • JSON in and out, UTF-8.
  • Field names in snake_case: net_amount, created_at.
  • Times in ISO 8601, UTC: 2026-10-29T09:51:36.516Z.
  • metadata: up to 20 keys of your own (text up to 500 characters, numbers, true/false), returned as sent. Never put personal or secret data in it.

Ids

Every object has an id with a prefix that says what it is: Quote the request id when you contact One Pay about a request: it leads straight to it in our logs.

Lists

Lists are newest first, a page at a time:
  • limit: how many per page, 1 to 100 (20 by default).
  • starting_after: the id of the last item you have, for the next page.