View the schema for a Recipient
Fetch the data requirements for a given currency, payout method type, and recipient type
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.
Path parameters
Query parameters
Allowed values: LocalBankTransfer, InternationalBankTransfer
The payout method.
Allowed values: The three-letter ISO 4217 code of a supported currency: AED, AUD, CAD, CHF, CNH, CZK, DKK, EUR, GBP, HKD, HUF, ILS, JPY, MXN, NOK, NZD, PLN, RON, SAR, SEK, SGD, TRY, USD, ZAR
The currency of the recipient.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The destination country of the payout method.
Allowed values: Individual, Business
The recipient type:
Individual– An account held by a natural personBusiness– An account held by a legal entity
Response
Field metadata returned by GET View the schema for a Recipient, including allowed values.
Field metadata returned by GET View the schema for a Recipient, including allowed values.
Field metadata returned by GET View the schema for a Recipient, including allowed values.
The schema of the IndividualRecipient property.
The schema of the BusinessRecipient property.
The schema of the InternationalBankTransfer property.
The schema of the LocalBankTransfer property.