List Payout Method Types
Retrieve a list of payout method types that you can use when creating a payout. The response returns one payout method type for each supported beneficiary country with the supported payout currencies.
The response contains a list of objects. Each object includes a payout method type and its attributes.
Note
The two-letter prefix of the payout method type matches the beneficiary country code.
This endpoint replaces the deprecated endpoints
GET /v1/payouts/supported_typesandGET /v1/payouts/payout_methods.Rapyd no longer supports the deprecated endpoints.
/v1/payout_method_types
List Payout Method Types - Payout Currency Specified
curl -X get 'https://sandboxapi.rapyd.net/v1/payout_method_types?payout_currency=USD' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "139c21fc-1b12-4f48-81a1-d8894b37c566" }, "data": [ { "payout_method_type": "th_ach_bank", "name": "Local transfer to Thailand", "is_cancelable": 0, "is_expirable": 0, "is_location_specific": 0, "status": 1, "image": "/checkout/th_ach_bank.png", "category": "bank", "beneficiary_country": "th", "sender_country": "*", "payout_currencies": [ "THB" ], "sender_entity_types": [ "company" ], "beneficiary_entity_types": [ "company", "individual" ], "amount_range_per_currency": [ { "maximum_amount": null, "minimum_amount": null, "payout_currency": "THB" } ], "minimum_expiration_seconds": null, "maximum_expiration_seconds": null, "sender_currencies": [ "USD", "SGD", "SEK", "NZD", "NOK", "JPY", "HKD", "GBP", "EUR", "DKK", "CHF", "CAD", "AUD" ], "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method." }, { "payout_method_type": "th_bangkokbank_bank", "name": "BANGKOK BANK", "is_cancelable": 0, "is_expirable": 0, "is_location_specific": 0, "status": 1, "image": "/checkout/th_bangkokbank_bank.png", "category": "bank", "beneficiary_country": "th", "sender_country": "*", "payout_currencies": [ "THB" ], "sender_entity_types": [ "company", "individual" ], "beneficiary_entity_types": [ "company", "individual" ], "amount_range_per_currency": [ { "maximum_amount": 500000, "minimum_amount": 50, "payout_currency": "THB" } ], "minimum_expiration_seconds": null, "maximum_expiration_seconds": null, "sender_currencies": [ "USD", "SGD", "NZD", "JPY", "HKD", "GBP", "CAD", "AUD" ], "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method." } ] }
List Payout Method Types - Multiple Query Filters
curl -X get 'https://sandboxapi.rapyd.net/v1/payout_method_types?beneficiary_country=MX&payout_currency=MXN' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "9ea1d171-957e-4305-a86a-6c6cf43d542a" }, "data": [ { "payout_method_type": "mx_abc_capital_bank", "name": "UALA", "is_cancelable": 0, "is_expirable": 0, "is_location_specific": 0, "status": 1, "image": "/checkout/mx_abc_capital_bank.png", "category": "bank", "beneficiary_country": "mx", "sender_country": "*", "payout_currencies": [ "MXN" ], "sender_entity_types": [ "company" ], "beneficiary_entity_types": [ "company", "individual" ], "amount_range_per_currency": [ { "maximum_amount": 999999999, "minimum_amount": 1, "payout_currency": "MXN" } ], "minimum_expiration_seconds": null, "maximum_expiration_seconds": null, "sender_currencies": [ "USD", "MXN", "GBP", "EUR" ], "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method." }, { "payout_method_type": "mx_actinver_bank", "name": "Actinver", "is_cancelable": 0, "is_expirable": 0, "is_location_specific": 0, "status": 1, "image": "/checkout/mx_actinver_bank.png", "category": "bank", "beneficiary_country": "mx", "sender_country": "*", "payout_currencies": [ "MXN" ], "sender_entity_types": [ "company" ], "beneficiary_entity_types": [ "company", "individual" ], "amount_range_per_currency": [ { "maximum_amount": 999999999, "minimum_amount": 1, "payout_currency": "MXN" } ], "minimum_expiration_seconds": null, "maximum_expiration_seconds": null, "sender_currencies": [ "USD", "MXN", "GBP", "EUR" ], "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method." } ] }
List Payout Method Types - Estimated Time of Arrival
curl -X get 'https://sandboxapi.rapyd.net/v1/payout_method_types?payout_currency=NZD' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "fccd1509-cb78-47f1-994c-b1e9f2780cd6" }, "data": [ { "payout_method_type": "nz_ach_bank", "name": "Local transfer to New Zealand", "is_cancelable": 0, "is_expirable": 0, "is_location_specific": 0, "status": 1, "image": "/checkout/nz_ach_bank.png", "category": "bank", "beneficiary_country": "nz", "sender_country": "*", "payout_currencies": [ "NZD" ], "sender_entity_types": [ "company" ], "beneficiary_entity_types": [ "company", "individual" ], "amount_range_per_currency": [ { "maximum_amount": null, "minimum_amount": null, "payout_currency": "NZD" } ], "minimum_expiration_seconds": null, "maximum_expiration_seconds": null, "sender_currencies": [ "USD", "SGD", "SEK", "NZD", "NOK", "JPY", "HKD", "GBP", "EUR", "DKK", "CHF", "CAD", "AUD" ], "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method." } ] }
Bad Request - Invalid Currency Value
curl -X get 'https://sandboxapi.rapyd.net/v1/payout_method_types?payout_currency=XYZ' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "INVALID_CURRENCY", "status": "ERROR", "message": "The request attempted an operation that requires a currency, but the value was missing or not recognized. The request was rejected. Corrective action: Use the correct 3-letter ISO 4217 code for the currency in uppercase letters.", "response_code": "INVALID_CURRENCY", "operation_id": "4223bceb-b107-4318-ac2b-ea1460d16f26" } }
Bad Request - Invalid Beneficiary Country Value
curl -X get 'https://sandboxapi.rapyd.net/v1/payout_method_types?beneficiary_country=XZ' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "INVALID_COUNTRY", "status": "ERROR", "message": "The request attempted an operation that requires a country, but the value was missing or not recognized. The request was rejected. Corrective action: Use the correct 2-letter ISO 3166-1 ALPHA-2 code for the country, in uppercase letters.", "response_code": "INVALID_COUNTRY", "operation_id": "02481ce1-f1ca-4e4e-99d8-e68e22cb3260" } }
Unauthorized
curl -X get 'https://sandboxapi.rapyd.net/v1/payout_method_types?payout_currency=USD' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "UNAUTHENTICATED_API_CALL", "status": "ERROR", "message": "The request was rejected due to an authentication issue. Corrective action: Check the status of your account in the 'Account Details' page of the Client Portal.", "response_code": "UNAUTHENTICATED_API_CALL", "operation_id": "f11a68b7-4b16-4e7b-b671-feeb3c686f06" } }