Customers route cheat sheet

Customer KYC is required for every end-customer. Banking routes below are optional — only after products.deposit_account.status=ready. Companion guides: Customer KYC quickstart · Quote and accept · Banking accounts. Auth: X-API-Key. Sandbox base: https://sandbox.elementpay.net/api/v1.

Vault KYC (required)

Method	Path	Notes
`GET`	`/partner/customers/requirements`	`type=individual\|business`, optional `country`
`POST`	`/partner/customers`	`partner_customer_ref`, `type`, `profile`
`GET`	`/partner/customers`	Optional `status`, `limit`, or `partner_customer_ref`
`GET`	`/partner/customers/{customer_id}`	Read `status`
`PATCH`	`/partner/customers/{customer_id}`	`{ "profile": { … } }` while incomplete
`POST`	`/partner/customers/{customer_id}/documents`	Base64; `category` from requirements
`POST`	`/partner/customers/{customer_id}/submit`	Incomplete → `422` + `missing[]`
`POST`	`/partner/customers/{customer_id}/revoke`	Partner offboard → `suspended`; optional `reason` (audit-only)

Signing keys (optional — customer-signed accepts)

Only when Console Signed accepts is on for the API key. EVM wallets only. Guide: Customer-signed accepts.

Method	Path	Notes
`POST`	`/partner/customers/{customer_id}/signing-keys/challenge`	`{ "address": "0x…" }` → `typed_data` + `key_id`
`POST`	`/partner/customers/{customer_id}/signing-keys/complete`	`{ "key_id", "signature" }` → active `skey_…`
`GET`	`/partner/customers/{customer_id}/signing-keys`	List; active key shows `next_nonce`
`POST`	`/partner/customers/{customer_id}/signing-keys/{key_id}/revoke`	Revoke

Accounts (banking — optional)

Requires vault status approved/active and products.deposit_account.status=ready. Otherwise 409.

Method	Path	Notes
`POST`	`/partner/customers/{customer_id}/accounts`	Open one rail; idempotent
`GET`	`/partner/customers/{customer_id}/accounts`	List; resolve `account_id`
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}`	Get one

Guide: Accounts.

Deposit instructions

Same banking gate as accounts. Coordinates may be 422 until the rail finishes provisioning.

Method	Path	Notes
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/deposit-instructions`	Fiat bank details or stablecoin wallet

Guide: Deposit instructions.

Stablecoin sends

Same banking gate. Resolve account_id via Accounts; fund via Deposit instructions when needed.

Method	Path	Notes
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/sends/preview`	→ `preview_token`
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/sends`	Confirm + `idempotency_key`
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/sends/{send_id}`	Poll status

Guide: Stablecoin sends.

Book transfers

Same banking gate (deposit_account=ready). Same-currency fiat → fiat under one API key.

Method	Path	Notes
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/book-transfers/preview`	`to_account_id`, `amount` → `preview_token`
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/book-transfers`	Confirm + `idempotency_key`

Guide: Book transfers. Legacy: /partner/entities/…/book-transfers (do not adopt).

Currency conversions

Same banking gate (deposit_account=ready). Cross-currency between two accounts owned by the same pcus_* (for example EUR → NGN before a payout). Binding rate comes from preview — not corridor GET /partner/rates/indicative.

Method	Path	Notes
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/conversions/preview`	`to_account_id`, `amount` → `preview_token`, `rate`, `expires_at`
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/conversions`	Confirm + `idempotency_key` (confirm before `expires_at`)

Guide: Currency conversions.

External bank payouts

Same banking gate (deposit_account=ready). Fiat → outside bank (not another ledger account). Same-currency only. Call discovery before preview. Sandbox full E2E is often unavailable (funding / beneficiary limits); see the guide Warning.

Method	Path	Notes
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/payout-methods`	Schemes + `required_fields` / `require_one_of`
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/payout-banks`	Local bank directory (`bank_code`) for NGN/GHS/CAD
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/payouts/preview`	`amount`, `beneficiary`, `bank` → `preview_token`
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/payouts`	Confirm + `idempotency_key`
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/payouts/{payout_id}`	Poll status

Guide: External bank payouts. Legacy: /partner/entities/…/payouts (do not adopt). Not the same as corridor GET /partner/banks.

Cards

Same banking gate (deposit_account=ready). Acquiring charges a card into fiat; issuing creates disposable/virtual USD cards. Sandbox USD / issuing may be limited; see the cards guide Warning.

Method	Path	Notes
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/card-charges`	Acquiring create
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/card-charges/{charge_id}`	Poll charge
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/cards`	Issue card (PAN/CVV on create only)
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/cards`	List
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/cards/{card_id}`	Get (no PAN/CVV)
`GET`	`/partner/customers/{customer_id}/accounts/{account_id}/cards/{card_id}/transactions`	Card txs
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/cards/{card_id}/freeze`	Freeze
`POST`	`/partner/customers/{customer_id}/accounts/{account_id}/cards/{card_id}/unfreeze`	Unfreeze

Guide: Cards. Legacy: /partner/entities/…/card-charges and /cards (do not adopt).

Orders (ramps)

Requires vault status=approved. Use customer_id — inline customer is deprecated but still supported.

Method	Path	Notes
`POST`	`/partner/orders/quote`	`customer_id` + `payment_method` + `asset`
`POST`	`/partner/orders/{quote_id}/accept`	`{}` body in most cases

Guide: Quote and accept.

Gate summary

Action	Required
Quote / accept with `customer_id`	`status=approved`
Account open / list / get	`approved`/`active` and `deposit_account.status=ready`
Deposit instructions	Same banking gate; 422 if coords not ready
Stablecoin send	Same banking gate; amount strictly below available
Book transfer	Same banking gate; same-currency fiat; `available >= amount`
Currency conversion	Same banking gate; cross-currency; same `pcus_*`; confirm before short `expires_at`
External bank payout	Same banking gate; `available >= amount`; sandbox E2E often needs Element Pay credit
Card charge / issue	Same banking gate; issuing is USD-account-only; KE individuals cannot open USD fiat (so cannot issue); issuing also blocked for some other residence countries; GBP/EUR charges UK/EU billing only; sandbox USD/issuing often limited

Get started

Customer KYC

Banking

Corridors

Sandbox

Route cheat sheet

Customers route cheat sheet

Vault KYC (required)

Signing keys (optional — customer-signed accepts)

Accounts (banking — optional)

Deposit instructions

Stablecoin sends

Book transfers

Currency conversions

External bank payouts

Cards

Orders (ramps)

Gate summary

​Customers route cheat sheet

​Vault KYC (required)

​Signing keys (optional — customer-signed accepts)

​Accounts (banking — optional)

​Deposit instructions

​Stablecoin sends

​Book transfers

​Currency conversions

​External bank payouts

​Cards

​Orders (ramps)

​Gate summary

Customers route cheat sheet

Vault KYC (required)

Signing keys (optional — customer-signed accepts)

Accounts (banking — optional)

Deposit instructions

Stablecoin sends

Book transfers

Currency conversions

External bank payouts

Cards

Orders (ramps)

Gate summary