Skip to main content

Error responses

Service error messages vary. This is not an exhaustive list of messages.

Validation errors

Validation errors return a message and an errors object with messages for each field. This example shows the shape only. Exact messages may differ:

Rate limits

  • Create Invoice is limited to 10 requests per minute.
  • Other routes may also return HTTP 429. Their limits are not documented.
  • No rate-limit response headers are documented. Back off before you retry after a 429.

Integration notes

  • Request format: the examples send JSON bodies with Content-Type: application/json.
  • Invoice amounts: send amount as a JSON string, for example "49.95", to preserve decimal precision.
  • Rate values: data.rate from Get Rate is a JSON number. It is a stored reference rate, not an executable or guaranteed price.
  • Webhook amounts: transaction.sent_amount, transaction.service_fee, and transaction.received_amount are JSON numbers. Invoice decimal fields such as amount_due and amount_paid are strings.
  • Webhook timestamps: Unix seconds, or JSON null when not recorded.
  • Fulfillment: fulfill invoices only when the callback reports fulfilled: true. See Webhooks.
  • XRP: always use the returned destination_tag when it is not null.
  • API keys: keep them in server-side secret storage. See API keys and authentication.