Create a partner order quote - Element Pay Partner API

curl --request POST \
  --url https://sandbox.elementpay.net/api/v1/partner/orders/quote \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "order_type": "OnRamp"
}
'

{
  "status": "success",
  "message": "Partner order quote created",
  "data": {
    "quote_id": "yc_receive_580e04c2-a136-5cca-be54-b49fcf80970c",
    "rail": "local_fiat",
    "status": "process",
    "order_type": "OnRamp",
    "route": {
      "family": "ramp_provider",
      "rail": "local_fiat",
      "direction": "payin",
      "mode": "auto",
      "reason": "Auto-routed for KE KES OnRamp."
    },
    "expires_at": "2026-05-16T08:13:40.322Z",
    "amounts": {
      "rate": 131.69,
      "rate_currency": "KES",
      "user_pays": {
        "amount": 800,
        "currency": "KES"
      },
      "user_receives": {
        "amount": 5.94999132,
        "currency": "USDC",
        "network": "BASE"
      },
      "fees": {
        "network_fee_usd": 0,
        "network_fee_local": 0,
        "service_fee_usd": 0.12,
        "service_fee_local": 16,
        "partner_fee_usd": 0,
        "partner_fee_local": 0
      }
    },
    "instructions": {
      "available_after_accept": true,
      "note": "Accept this quote to create the local order and receive final payment instructions."
    },
    "audit": {
      "rail": "local_fiat",
      "provider_quote_id": "580e04c2-a136-5cca-be54-b49fcf80970c",
      "direction": "payin",
      "token_symbol": "BASE_USDC",
      "crypto_currency": "USDC",
      "crypto_network": "BASE"
    }
  }
}

{
  "status": "error",
  "message": "elementpay partner order routing is not enabled yet",
  "data": {
    "route": {
      "family": "native",
      "direction": "payin",
      "mode": "override",
      "reason": "Provider override requested: rail.",
      "rail": "native"
    }
  }
}

{
  "status": "error",
  "message": "Missing requirements for selected route",
  "data": {
    "missing_fields": [
      "wallet_address",
      "recipient or customer",
      "source or payment_method"
    ],
    "route": {
      "family": "ramp_provider",
      "direction": "payin",
      "mode": "auto",
      "reason": "Selected rail for KE KES OnRamp.",
      "rail": "local_fiat"
    }
  }
}

{
  "status": "error",
  "message": "Quote request failed",
  "data": null
}

POST

partner

orders

quote

curl --request POST \
  --url https://sandbox.elementpay.net/api/v1/partner/orders/quote \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "order_type": "OnRamp"
}
'

{
  "status": "success",
  "message": "Partner order quote created",
  "data": {
    "quote_id": "yc_receive_580e04c2-a136-5cca-be54-b49fcf80970c",
    "rail": "local_fiat",
    "status": "process",
    "order_type": "OnRamp",
    "route": {
      "family": "ramp_provider",
      "rail": "local_fiat",
      "direction": "payin",
      "mode": "auto",
      "reason": "Auto-routed for KE KES OnRamp."
    },
    "expires_at": "2026-05-16T08:13:40.322Z",
    "amounts": {
      "rate": 131.69,
      "rate_currency": "KES",
      "user_pays": {
        "amount": 800,
        "currency": "KES"
      },
      "user_receives": {
        "amount": 5.94999132,
        "currency": "USDC",
        "network": "BASE"
      },
      "fees": {
        "network_fee_usd": 0,
        "network_fee_local": 0,
        "service_fee_usd": 0.12,
        "service_fee_local": 16,
        "partner_fee_usd": 0,
        "partner_fee_local": 0
      }
    },
    "instructions": {
      "available_after_accept": true,
      "note": "Accept this quote to create the local order and receive final payment instructions."
    },
    "audit": {
      "rail": "local_fiat",
      "provider_quote_id": "580e04c2-a136-5cca-be54-b49fcf80970c",
      "direction": "payin",
      "token_symbol": "BASE_USDC",
      "crypto_currency": "USDC",
      "crypto_network": "BASE"
    }
  }
}

{
  "status": "error",
  "message": "elementpay partner order routing is not enabled yet",
  "data": {
    "route": {
      "family": "native",
      "direction": "payin",
      "mode": "override",
      "reason": "Provider override requested: rail.",
      "rail": "native"
    }
  }
}

{
  "status": "error",
  "message": "Missing requirements for selected route",
  "data": {
    "missing_fields": [
      "wallet_address",
      "recipient or customer",
      "source or payment_method"
    ],
    "route": {
      "family": "ramp_provider",
      "direction": "payin",
      "mode": "auto",
      "reason": "Selected rail for KE KES OnRamp.",
      "rail": "local_fiat"
    }
  }
}

{
  "status": "error",
  "message": "Quote request failed",
  "data": null
}

Create a binding quote for a fiat ↔ crypto order.

Create quote

POST with corridor, customer, and payment method details.

Show pricing

Display returned amounts and payment instructions to the user (OnRamp).

POST /partner/orders/{quote_id}/accept when the user confirms.

Customer identity

Use one of:

customer_id (pcus_* from an approved customer vault case) — recommended for new integrations
Inline customer — still supported; pick KE OnRamp — inline customer in Try it or fill the customer object

Do not send both. Corridor-specific inline shapes: Sandbox test payloads.

Try it omits legacy top-level fields (provider, channel_id, destination, rail, …). Omit provider on live calls too — Element Pay auto-routes by corridor.

Discovery before quote

GET /partner/catalog or GET /partner/payment-methods → rails for the corridor
GET /partner/catalog?order_type=OnRamp or OffRamp → providers[].id for momo/bank
GET /partner/order-requirements → exact field names (network_id required for momo/bank)
GET /partner/banks → bank institution UUIDs where applicable

Payment method by rail

mobile_money

payment_method.type=mobile_money
payment_method.phone_number (E.164)
payment_method.network_id (UUID from catalog providers[].id)

bank

payment_method.type=bank
account_number, account_name
payment_method.network_id (from GET /partner/banks or catalog)

Quote IDs

OnRamp: yc_receive_<id>
OffRamp: yc_send_<id>

The quote expires at data.expires_at.

Authorizations

X-API-Key

string

header

required

Partner API key. Sandbox keys start with is_test_; production keys start with is_live_. Keys are not interchangeable across environments. Send on every request. Never expose in browser or mobile clients.

Body

application/json

Quote body for Mintlify Try it. Includes customer_id or inline customer, asset, and payment_method only. Not shown here (still accepted on live API if needed): provider, channel_id, channel_type, sequence_id, destination, source, sender, recipient, rail, token top-level alias, crypto_currency/crypto_network hints.

order_type

enum<string>

required

OnRamp = fiat to crypto. OffRamp = crypto to fiat.

Available options:

OnRamp,

OffRamp

Example:

"OnRamp"

country

string

ISO country (African corridors). Omit for EUR/USD international bank payin.

Required string length: 2

Example:

"KE"

currency

string

Required string length: 3

Example:

"KES"

local_amount

integer

OnRamp: fiat amount the customer pays.

Required range: x >= 1

Example:

800

crypto_amount

number

OffRamp: stablecoin amount the customer sends.

Example:

20

customer_id

string

Approved vault customer id (pcus_*). Use this or inline customer, not both.

Example:

"pcus_a1b2c3d4e5f6"

customer

object

Inline retail KYC when you do not use customer_id. Corridor extras (BVN, institution): /sandbox/test-payloads.

Show child attributes

asset

object

Stablecoin asset block (sandbox default: Base USDC).

Show child attributes

payment_method

object

Fiat rail. mobile_money: phone_number + network_id. bank: account_number, account_name, network_id.

Show child attributes

wallet_address

string

OnRamp: destination wallet for stablecoin delivery.

Example:

"0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe"

refund_address

string

OffRamp: refund wallet if payout fails.

Example:

"0x3333333333333333333333333333333333333333"

Response

Partner order quote created

status

enum<string>

required

Available options:

success

message

string

required

data

object

required

​Customer identity

​Discovery before quote

​Payment method by rail

​Quote IDs

Authorizations

Body

Response

Customer identity

Discovery before quote

Payment method by rail

Quote IDs