Skip to main content
Find endpoints for payment intents, beneficiaries, payouts, and payout funding. All partner API routes use the /v1 prefix.
See Environments for alternate hosts and isolation rules.

​
Shared conventions

  • HTTPS and UTF-8 JSON only.
  • Server-to-server calls use HMAC authentication.
  • Errors use error.code and error.message. Retain error.request_id when present; funding errors currently omit it.
  • Store resource IDs and idempotency keys as opaque strings.
  • Treat asynchronous resource reads as authoritative after network ambiguity.

​
Money conventions

Never send a floating-point value for a Platform Payout or a local-currency minor-unit field.

​
QR Payments reference

Create intent

Create a payment intent and receive its session token.

Scan QR

Validate a merchant QR and bind its quote.

Confirm intent

Confirm once and start asynchronous delivery.

Get intent

Retrieve authoritative payment state.

Session and receipt tokens

Re-mint a checkout session or open a receipt.

QR Payments webhooks

Verify payment-intent events.

​
Platform Payouts reference

Beneficiaries

Create reusable bank destinations.

Payouts API

Create, retrieve, list, and interpret payouts.

Funding

Deposit USD, reserve a conversion, and check available payout balances.

Payout webhooks

Verify payout lifecycle events.
The downloadable OpenAPI 3.1 document covers payment intents, beneficiaries, and payouts. Funding endpoints and their current response fields are documented in Fund your payout balance. Product pages remain the canonical guides for lifecycle, retry, webhook, and sandbox behavior.