v2
latestOpenAPI 3.1.02026-07-262279731.3 MBView the schema for a Recipient
Fetch the data requirements for a given currency, payout method type, and recipient type
Path parameters
Platform's API account identifier, associated with the API key.
Query parameters
Allowed values: LocalBankTransfer, InternationalBankTransfer
The payout method.
Allowed values: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> of a <a href="/guides/currencies" target="_blank">supported currency</a>: 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 person
- Business – An account held by a legal entity
Headers
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.
Response
Success