Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount_range_per_currency | List[List[PayoutAmountRangePerCurrencyInner]] | ❌ | An array of objects that describe limits on the amount, per currency. Contains the following fields: maximum_amount - Maximum amount supported by this payout method for the indicated currency. Decimal number. minimum_amount - Minimum amount supported by this payout method for the indicated currency. Decimal number. * payout_currency - Currency of the payout. Three-letter ISO 4217 code. Uppercase. |
| beneficiary_country | str | ❌ | Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code. The two-letter prefix of the payout method type must match the beneficiary country code. |
| beneficiary_entity_types | List[EntityType] | ❌ | A list of the beneficiary entity types supported by this payout method. One or more of the following: company individual Response only. |
| category | Category | ❌ | |
| image | str | ❌ | URL of an image that the merchant can use to represent the payout method. |
| is_cancelable | int | ❌ | Indicates whether the payout can be canceled. Relevant when category is cash. One of the following values 0 - Not cancelable. 1 - cancelable.' |
| is_expirable | int | ❌ | Indicates whether the payout expires if not completed. Relevant when category is cash. One of the following values 0 - Not expirable. 1 - expirable.' |
| is_location_specific | int | ❌ | Indicates whether the payout must be made at a specific physical location. Relevant when category is cash. One of the following values 0 - Not locationspecific. 1 - location specific.' |
| maximum_expiration_seconds | float | ❌ | The maximum time (in seconds) that the merchant can set for completing the payout. Relevant when is_expirable is true. |
| minimum_expiration_seconds | float | ❌ | The minimum time (in seconds) that the merchant can set for completing the payout. Relevant when is_expirable is true. |
| name | str | ❌ | Payout method name. |
| payout_currencies | List[str] | ❌ | A list of the currencies supported by this payout method. Three-letter ISO 4217 code. Uppercase. Response only. |
| payout_method_type | str | ❌ | The type of payout method. The two-letter prefix must match the beneficiary country code. Required when default_payout_method_type is not used. |
| sender_country | str | ❌ | Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code. The two-letter prefix of the payout method type must match the beneficiary country code. |
| sender_currencies | List[str] | ❌ | List of currencies that the sender is paying with. Currency consists of a three-letter ISO 4217 code. Response only. |
| sender_entity_types | List[EntityType] | ❌ | A list of the sender entity types supported by this payout method. One or more of the following: company individual Response only. |
| estimated_time_of_arrival | str | ❌ | The estimated time period in which the beneficiary will receive the funds. |
| status | int | ❌ | Indicates whether the payout method is currently available. One of the following values: 0 - Not available. 1 - Available. |