Skip to main content
GET
Indicative order field requirements for a corridor
Returns partner-neutral field name hints before POST /partner/orders/quote. Call after GET /partner/corridors and GET /partner/payment-methods.

Query

country, currency, order_type (OnRamp or OffRamp). When several payout rails exist, list them with GET /partner/payment-methods first, then pass payment_method_type (e.g. BankSepa) on this call. Single-rail international bank corridors (e.g. GH) may omit it.

Rails

  • mobile_money or bank — both require network_id on quote (from catalog providers[].id or GET /partner/banks for bank)
  • Optional customer_type (retail or institution) on local fiat corridors
This endpoint does not return JSON Schema, bank lists, fees, or provider labels. Bank lists and dynamic form schemas are separate partner endpoints (see Quickstart).

Authorizations

X-API-Key
string
header
required

Query Parameters

country
string
required

ISO country code.

Required string length: 2
currency
string
required

Fiat currency code.

Required string length: 3
order_type
string
required

OnRamp or OffRamp.

Example:

"OffRamp"

customer_type
string
default:retail

retail or institution — affects required customer fields on local fiat rail corridors.

payment_method_type
string | null

Narrows payment_method requirements: mobile_money | bank (rail) or international bank PaymentMethodType from payment-methods (e.g. BankLocal).

Response

Indicative field requirements before quote

status
enum<string>
required
Available options:
success
message
string
required
data
object