# Element Pay Partner API

## Docs

- [Introduction](https://partners.elementpay.net/introduction.md)
- [Quickstart](https://partners.elementpay.net/quickstart.md)
- [Authentication](https://partners.elementpay.net/authentication.md)
- [Webhooks](https://partners.elementpay.net/webhooks.md)
- [Errors](https://partners.elementpay.net/errors.md)
- [Quickstart](https://partners.elementpay.net/customers/quickstart.md)
- [Accounts](https://partners.elementpay.net/customers/accounts.md)
- [Deposit instructions](https://partners.elementpay.net/customers/deposit-instructions.md)
- [Stablecoin sends](https://partners.elementpay.net/customers/stablecoin-sends.md)
- [Book transfers](https://partners.elementpay.net/customers/book-transfers.md)
- [Payouts](https://partners.elementpay.net/customers/payouts.md)
- [Cards](https://partners.elementpay.net/customers/cards.md)
- [Route cheat sheet](https://partners.elementpay.net/customers/route-cheat-sheet.md)
- [Overview](https://partners.elementpay.net/corridors/overview.md)
- [Kenya](https://partners.elementpay.net/corridors/kenya.md)
- [Nigeria](https://partners.elementpay.net/corridors/nigeria.md)
- [Uganda](https://partners.elementpay.net/corridors/uganda.md)
- [Onboarding](https://partners.elementpay.net/sandbox/onboarding.md)
- [Success failure](https://partners.elementpay.net/sandbox/success-failure.md)
- [Test payloads](https://partners.elementpay.net/sandbox/test-payloads.md)
- [Indicative fiat vs USD rates](https://partners.elementpay.net/api-reference/partner/indicative-fiat-vs-usd-rates.md): Returns **indicative** ``buy`` / ``sell`` rates for the requested ISO fiat codes — **not** a binding quote (use ``POST /partner/orders/quote`` for checkout pricing). Response body: ``requested``, ``rates``, ``fetched_at``. **Auth:** ``X-API-Key``.
- [Supported partner corridors (African markets and international bank)](https://partners.elementpay.net/api-reference/partner/supported-partner-corridors-african-markets-and-international-bank.md): Indicative catalog for partner checkout UI. **african_markets** — local fiat corridors (country + currency, onramp/offramp flags). **international_bank** — EUR/USD bank transfer payin; currency only, no ISO country. Binding eligibility: ``POST /partner/orders/quote``.
- [Checkout catalog (corridors, methods, and providers)](https://partners.elementpay.net/api-reference/partner/checkout-catalog-corridors-methods-and-providers.md): Single indicative catalog for partner checkout UI: per-country onramp/offramp, ``mobile_money`` and ``bank`` buckets with live provider lists, optional ``rails`` for international payout markets, and ``international_bank`` for EUR/USD payin. Composed from cached upstream discovery APIs (refreshed pe…
- [Payment method types for a corridor](https://partners.elementpay.net/api-reference/partner/payment-method-types-for-a-corridor.md): Indicative payment methods for one corridor. **African:** ``country`` (required). ``currency`` is optional and must match the catalog when sent; response ``context`` always includes both. Optional ``order_type`` (``OnRamp`` or ``OffRamp``); omit to get both ``onramp`` and ``offramp`` buckets. **Inte…
- [Indicative order field requirements for a corridor](https://partners.elementpay.net/api-reference/partner/indicative-order-field-requirements-for-a-corridor.md): Returns partner-neutral **field name** hints before ``POST /partner/orders/quote``. Call after ``GET /corridors`` and ``GET /payment-methods``. Query: ``country``, ``currency``, ``order_type`` (OnRamp or OffRamp). List payout rails with ``GET /payment-methods`` first when several exist; pass ``payme…
- [Indicative bank/network options for a rail](https://partners.elementpay.net/api-reference/partner/indicative-banknetwork-options-for-a-rail.md): Lists partner-neutral bank/network options for a rail chosen via ``GET /partner/payment-methods``. Query: ``country``, ``currency``, ``order_type`` (OnRamp or OffRamp), and ``payment_method_type``. local fiat rail rails support ``payment_method_type=bank`` (active networks only). ``payment_method_ty…
- [Create a partner order quote](https://partners.elementpay.net/api-reference/partner/create-a-partner-order-quote.md): Create a binding quote for a fiat ↔ crypto order. **Flow:** create a quote → show the returned amounts and payment instructions to the user → accept the `quote_id` with `POST /partner/orders/{quote_id}/accept`. **Discovery before quote:** - `GET /partner/catalog` or `GET /partner/payment-methods` →…
- [Get a partner order](https://partners.elementpay.net/api-reference/partner/get-a-partner-order.md): Returns the current status of an order created via ``POST /partner/orders/{quote_id}/accept``. Scoped to the authenticated API key. Use webhooks as the primary source of truth; this endpoint is a backup for polling when delivery is delayed.
- [Accept a partner order quote](https://partners.elementpay.net/api-reference/partner/accept-a-partner-order-quote.md): Accepts a quote returned by `/partner/orders/quote`. For local fiat rail, the `quote_id` already contains the provider and direction, so the request body can be `{}`. international bank quote ids work the same way. Accepting creates or returns the local ElementPay order, copies the API key webhook U…
- [Customer KYC package requirements](https://partners.elementpay.net/api-reference/partner-customers/customer-kyc-package-requirements.md): Return required profile fields and document categories for a customer type.
- [List customers for this partner tenant](https://partners.elementpay.net/api-reference/partner-customers/list-customers-for-this-partner-tenant.md): List tenant-scoped customers (metadata only).
- [Create a customer vault case](https://partners.elementpay.net/api-reference/partner-customers/create-a-customer-vault-case.md): Create an incomplete customer case (idempotent on partner_customer_ref).
- [Get a customer vault case](https://partners.elementpay.net/api-reference/partner-customers/get-a-customer-vault-case.md): Get one tenant-owned customer including document metadata and missing[].
- [Update a draft or correct a failed deposit-KYC profile](https://partners.elementpay.net/api-reference/partner-customers/update-a-draft-or-correct-a-failed-deposit-kyc-profile.md): Merge profile fields on a draft. A correction after failed deposit-account KYC invalidates prior approval and returns the customer to ``incomplete`` for resubmission and re-review.
- [Upload a customer document](https://partners.elementpay.net/api-reference/partner-customers/upload-a-customer-document.md): Upload a base64 document into the vault (off-host store + DB metadata). A correction after failed deposit-account KYC invalidates prior approval and returns the customer to ``incomplete`` for resubmission and re-review.
- [Submit customer package for review](https://partners.elementpay.net/api-reference/partner-customers/submit-customer-package-for-review.md): Submit an incomplete package → pending_review, or 422 with missing[].
- [Retry deposit account provisioning after a failed attempt](https://partners.elementpay.net/api-reference/partner-customers/retry-deposit-account-provisioning-after-a-failed-attempt.md): Re-queue an unchanged KYC/KYB attempt after a transient failure. Only valid when the customer is EP-approved and ``deposit_account.status`` is ``failed``. Profile/document corrections invalidate approval; after a correction, complete the package and submit it for EP review again.
- [List accounts for a ready customer](https://partners.elementpay.net/api-reference/partner-customer-accounts/list-accounts-for-a-ready-customer.md): List customer accounts, refreshing pending coordinates when available.
- [Open an account for a ready customer](https://partners.elementpay.net/api-reference/partner-customer-accounts/open-an-account-for-a-ready-customer.md): Open one idempotent fiat or stablecoin rail. Same rail tuple returns the existing account.
- [Get one account for a ready customer](https://partners.elementpay.net/api-reference/partner-customer-accounts/get-one-account-for-a-ready-customer.md): Get one customer-owned account and its current coordinates.
- [Get deposit instructions for an account](https://partners.elementpay.net/api-reference/partner-customer-accounts/get-deposit-instructions-for-an-account.md): Funding coordinates for one customer account (fiat bank details or stablecoin wallet). Account must be active with usable coordinates.
- [Preview a stablecoin send for a ready customer account](https://partners.elementpay.net/api-reference/partner-customer-accounts/preview-a-stablecoin-send-for-a-ready-customer-account.md): Preview fees and amounts for a stablecoin send.
- [Confirm a stablecoin send for a ready customer account](https://partners.elementpay.net/api-reference/partner-customer-accounts/confirm-a-stablecoin-send-for-a-ready-customer-account.md): Submit a stablecoin send using a prior preview token.
- [Get a stablecoin send for a ready customer account](https://partners.elementpay.net/api-reference/partner-customer-accounts/get-a-stablecoin-send-for-a-ready-customer-account.md): Get one stablecoin send status for a customer-owned account.
- [Preview a fiat book-transfer for a ready customer account](https://partners.elementpay.net/api-reference/partner-customer-accounts/preview-a-fiat-book-transfer-for-a-ready-customer-account.md)
- [Confirm a fiat book-transfer for a ready customer account](https://partners.elementpay.net/api-reference/partner-customer-accounts/confirm-a-fiat-book-transfer-for-a-ready-customer-account.md)

## OpenAPI Specs

- [openapi](https://partners.elementpay.net/openapi.json)