v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
Recipients

View payout methods

See payout methods available to your platform by currency and country

get/v2.01/{ClientId}/recipients/payout-methods

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

Query parameters

Currencystring required

Possible values: 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 payout method.

Countrystring required

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The destination country of the payout method.

Headers

Authorizationstring required

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

AvailablePayoutMethodsstring[]

Possible values: LocalBankTransfer, InternationalBankTransfer

The payout methods available for the currency and country combination.