List Payout Method Types
GET {{baseUrl}}/v1/payout_methods?sender_entity_type=<string>&beneficiary_country=<string>&payout_currency=<string>&sender_currency=<string>&sender_country=<string>&beneficiary_entity_type=<string>&category=<string>&is_cancelable=<boolean>&is_location_specific=<boolean>&is_expirable=<boolean>&starting_after=<string>&ending_before=<string>&limit=<string>
Retrieve a list of payout method types that you can use when creating a payout. The response contains a list of objects. Each object includes a payout method type and its attributes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sender_entity_type | string | Filters the type of entity for the payer. One of the following: individual, company | |
beneficiary_country | string | Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code. | |
payout_currency | string | Currency received by the beneficiary. Three-letter ISO 4217 code. | |
sender_currency | string | Currency that the sender is paying with. Three-letter ISO 4217 code. | |
sender_country | string | Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code. Note: This field does not appear in the response. | |
beneficiary_entity_type | string | Filters the type of entity for the beneficiary. One of the following: individual, company | |
category | string | The category of payout method. One of the following: bank, card, cash, rapyd_ewallet, ewallet | |
is_cancelable | string | Indicates whether the payout can be canceled. Relevant when category is cash. | |
is_location_specific | string | Indicates whether the payout must be made at a specific physical location. Relevant when category is cash. | |
is_expirable | string | Indicates whether the payout expires if not completed. Relevant when category is cash. | |
starting_after | string | The name of a payout method in the list. The list begins with the record that was created next after the record with this payout method. Use this filter to get the next page of results. Relevant when ending_before is not used. | |
ending_before | string | The name of a payout method in the list. The list ends with the last record that was created before the record with this payout method. Use this filter to get the previous page of results. | |
limit | string | The maximum number of payout methods to return. Range: 1-100. Default is 10. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"amount_range_per_currency":[[{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","payout_currency":"BOB"},{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","payout_currency":"MUR"}],[{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","payout_currency":"XOF"},{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","payout_currency":"EGP"}]],"beneficiary_country":"OM","beneficiary_entity_types":["company","company"],"category":"ewallet","image":"\u003cstring\u003e","is_cancelable":"\u003cinteger\u003e","is_expirable":"\u003cinteger\u003e","is_location_specific":"\u003cinteger\u003e","maximum_expiration_seconds":"\u003cnumber\u003e","minimum_expiration_seconds":"\u003cnumber\u003e","name":"\u003cstring\u003e","payout_currencies":["JPY","BSD"],"payout_method_type":"\u003cstring\u003e","sender_country":"QA","sender_currencies":["SZL","BWP"],"sender_entity_types":["individual","individual"],"estimated_time_of_arrival":"\u003cstring\u003e","status":"\u003cinteger\u003e"},{"amount_range_per_currency":[[{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","payout_currency":"ZMW"},{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","payout_currency":"GNF"}],[{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","payout_currency":"BIF"},{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","payout_currency":"LSL"}]],"beneficiary_country":"GD","beneficiary_entity_types":["individual","individual"],"category":"card","image":"\u003cstring\u003e","is_cancelable":"\u003cinteger\u003e","is_expirable":"\u003cinteger\u003e","is_location_specific":"\u003cinteger\u003e","maximum_expiration_seconds":"\u003cnumber\u003e","minimum_expiration_seconds":"\u003cnumber\u003e","name":"\u003cstring\u003e","payout_currencies":["NAD","SRD"],"payout_method_type":"\u003cstring\u003e","sender_country":"PK","sender_currencies":["LKR","PEN"],"sender_entity_types":["individual","company"],"estimated_time_of_arrival":"\u003cstring\u003e","status":"\u003cinteger\u003e"}],"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}