Start

Errors

Failed calls return success: false and a message. Validation errors also include an errors object.

Treat any non-2xx response as a failure. Do not credit a customer from a quote alone. Credit them when the webhook says the deposit settled, or when you read a credited settlement from the API.

Status codes

  • 401

    Unauthorized

    Missing or invalid keys, a bad signature, or an expired timestamp.

  • 404

    Not found

    The customer, address, or transaction does not belong to this merchant.

  • 422

    Unprocessable

    The body failed validation or a business rule (for example account name mismatch or insufficient balance).

  • 403

    Forbidden

    A sandbox key called a live-only route such as payouts, a live key called /sandbox/deposits, or the request IP is not on your API allowlist.

  • 429

    Too many requests

    Quote, sandbox deposit, bank resolve, and payout calls are rate limited.

  • 503

    Unavailable

    A wallet address could not be created. Retry shortly.

{
  "success": false,
  "message": "Invalid API credentials."
}