Endpoints
23 operations, generated from the OpenAPI spec (v2026-08-18). Every path is prefixed with your API base URL, and :org is the organization id you were issued — not the organizationId that appears inside response bodies. Full reference · OpenAPI YAML
Discovery#
What you can pay, and what each corridor needs.
| Method | Path | Purpose |
|---|---|---|
| GET | /recipients/:org/corridors | Currencies you can pay out to, and the fields each needs |
Pricing#
What a payout costs, before and after a beneficiary exists.
| Method | Path | Purpose |
|---|---|---|
| GET | /payments/organizations/:org/rates | Price a corridor before a beneficiary exists |
| POST | /payments/organizations/:org/quotes/offramp | Lock a price against a real beneficiary |
Beneficiaries#
Who is being paid.
| Method | Path | Purpose |
|---|---|---|
| GET | /recipients/:org | Beneficiaries, optionally for one of your end users |
| POST | /recipients/:org | Register who is being paid |
| POST | /recipients/:org/{recipientId}/methods | Add another way to pay an existing beneficiary |
Payouts#
Moving the money, and reading what happened.
| Method | Path | Purpose |
|---|---|---|
| POST | /payments/organizations/:org/quotes/accept | Send the money |
| POST | /payments/organizations/:org/payouts | Price and send in one call |
| POST | /payments/organizations/:org/payout-links | Mint a one-time link for the person being paid |
| GET | /payout-links/{token} | What the recipient's page renders |
| POST | /payout-links/{token}/submit | Spend the link and send the money |
| POST | /payments/organizations/:org/payouts/{payoutId}/cancel | Stop a payout that has not moved yet |
| GET | /payments/organizations/:org/payouts/{payoutId}/funding | How to fund a payout that needs it |
| POST | /payments/organizations/:org/payouts/{payoutId}/funding/confirm | Tell us you have sent the funds |
| GET | /payments/organizations/:org/events | Everything that has happened to your payouts, in order |
| GET | /payments/organizations/:org/orders | Recent payouts |
| GET | /payments/organizations/:org/orders/{payoutId} | One payout, always live |
Funding#
Topping up the balance payouts debit.
| Method | Path | Purpose |
|---|---|---|
| GET | /payments/organizations/:org/balance/history | Why the balance is what it is |
| GET | /payments/organizations/:org/balance | What you can currently send |
| GET | /payments/organizations/:org/payin-accounts | Where to wire money to top up your balance |
Sandbox#
| Method | Path | Purpose |
|---|---|---|
| POST | /payments/organizations/:org/sandbox/fund | Credit a sandbox balance |
| POST | /payments/organizations/:org/sandbox/webhook-endpoints | Register a sandbox webhook endpoint and get its signing secret |
| GET | /payments/organizations/:org/sandbox/webhook-endpoints/{endpointId}/deliveries | What we sent, what came back, and what we retried |