Skip to main content
GET
Get recipient fields
Returns the fields to collect for a recipient in one payout corridor, together with each field’s validation rules and options.
This is the corridor-aware field catalogue, keyed on country, currency, rail and party type. It is the one endpoint that answers what to collect for a recipient — call it before Add recipient.
Pass transferType when both parties are known; pass recipientType when creating a recipient and the sender does not exist yet. With recipientType, a field is reported REQUIRED only if it is required under every transfer type still possible — the widest answer that cannot reject a payload the provider would have accepted. Read corridor.transferTypeMatch to see which happened.
GBP recipients also list sortCode (6 digits), bankPostalCode (the bank’s UK postcode, sent as institutionalAddress.postalCode) and an 8-digit bankAccountNumber. bankBranchCode is satisfied by sortCode.

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Query Parameters

currency
string
required

Payout currency. With payoutRail, identifies the corridor.

Example:

"CNY"

payoutRail
string
required

Payout rail. With currency, identifies the corridor.

Example:

"BANK_TRANSFER"

country
string

ISO-3166 alpha-3 payout country. Only needed where one currency is paid out in several countries with different requirements — USD and EUR cash pickup. Derived from the currency and rail when omitted.

Example:

"CHN"

transferType
enum<string>

B2B, B2C, C2C or C2B. Pass this when both parties are already known — it gives the provider's exact field set. Wins over recipientType when both are sent.

Available options:
B2B,
B2C,
C2C,
C2B
recipientType
enum<string>

INDIVIDUAL or BUSINESS — the type of the recipient you are collecting for. Use this at creation time, when the counterparty does not exist yet: the answer folds together every transfer type still possible, so nothing is demanded that a later counterparty could make unnecessary.

Available options:
INDIVIDUAL,
BUSINESS
Example:

"INDIVIDUAL"

Response

The corridor was resolved. fields may legitimately be empty — for a sender on a rail without POBO, or a party the provider asks nothing about. Unwrapped — the body is the object below, with no envelope.

corridor
object

The corridor the answer was resolved for.

poboSupported
boolean

Whether this corridor supports POBO. Only present on the sender endpoint; null for recipients.

catalogVersion
string

Version of the field catalogue the answer came from.

fields
object[]

One entry per field, in the order you should render them.