API reference

Interactive reference for the Element Pay Partner API. Use Try it with your sandbox X-API-Key - requests go to the sandbox base URL configured for this site. Auth header: X-API-Key. Try-it sidebar groups follow OpenAPI tags: Partner · Customers · Customer accounts · Customer transfers · Customer payouts.

Corridor discovery + orders

OpenAPI tag: partner.

Method	Path
`GET`	`/partner/catalog`
`GET`	`/partner/corridors`
`GET`	`/partner/payment-methods`
`GET`	`/partner/order-requirements`
`GET`	`/partner/banks`
`GET`	`/partner/rates/indicative`
`POST`	`/partner/orders/quote`
`POST`	`/partner/orders/{quote_id}/accept`
`GET`	`/partner/orders/{order_id}`

GET /partner/rates/indicative is corridor fiat vs USD only — not ledger convert pricing. For cross-currency ledger FX use Currency conversions. Guides: Quickstart · Quote and accept.

Customers (vault KYC)

OpenAPI tag: partner-customers.

Method	Path
`GET`	`/partner/customers/requirements`
`POST`	`/partner/customers`
`GET`	`/partner/customers`
`GET`	`/partner/customers/{customer_id}`
`PATCH`	`/partner/customers/{customer_id}`
`POST`	`/partner/customers/{customer_id}/documents`
`POST`	`/partner/customers/{customer_id}/submit`
`POST`	`/partner/customers/{customer_id}/revoke`
`POST`	`/partner/customers/{customer_id}/deposit-account/retry`

Guide: Customers quickstart.

Customer accounts

OpenAPI tag: partner-customer-accounts. Requires vault approved/active and products.deposit_account.status=ready for banking rails.

Method	Path	Notes
`POST` / `GET`	`…/accounts`	Open / list
`GET`	`…/accounts/{account_id}`	Get one
`GET`	`…/deposit-instructions`	Fiat or stablecoin funding coordinates

Guide: Accounts · Deposit instructions.

Customer transfers

OpenAPI tag: partner-customer-transfers. Same banking gate. On-ledger moves (not external bank push).

Method	Path	Notes
`POST`	`…/sends/preview` · `…/sends` · `GET …/sends/{id}`	Stablecoin sends
`POST`	`…/book-transfers/preview` · `…/book-transfers`	Same-currency fiat
`POST`	`…/conversions/preview` · `…/conversions`	Cross-currency; confirm before `expires_at`

Guides: Stablecoin sends · Book transfers · Currency conversions.

Customer payouts

OpenAPI tag: partner-customer-payouts. Same banking gate. Same-currency fiat → outside bank.

Method	Path	Notes
`GET`	`…/payout-methods`	Schemes + `required_fields` / `require_one_of`
`GET`	`…/payout-banks`	Local `bank_code` directory (NGN / GHS / CAD)
`POST`	`…/payouts/preview`	→ `preview_token`
`POST`	`…/payouts`	Confirm + `idempotency_key`
`GET`	`…/payouts/{payout_id}`	Poll

Not the same as corridor GET /partner/banks (quote network_id). Guide: External bank payouts · Route cheat sheet.

Try it

Open an endpoint under this tab (sidebar groups match the tags above).
Set X-API-Key to your sandbox key.
Recommended banking order: accounts → deposit-instructions → transfers (sends / book / conversions) → for external payouts: payout-methods → payout-banks → payouts/preview.

​API reference

​Corridor discovery + orders

​Customers (vault KYC)

​Customer accounts

​Customer transfers

​Customer payouts

​Try it