Skip to main content

PayoutMethodType

Properties

NameTypeRequiredDescription
amount_range_per_currencyList[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_countrystr
beneficiary_entity_typesList[EntityType]A list of the beneficiary entity types supported by this payout method. One or more of the following: company individual Response only.
categoryCategory
imagestrURL of an image that the merchant can use to represent the payout method.
is_cancelableintIndicates whether the payout can be canceled. Relevant when category is cash. One of the following values 0 - Not cancelable. 1 - cancelable.'
is_expirableintIndicates whether the payout expires if not completed. Relevant when category is cash. One of the following values 0 - Not expirable. 1 - expirable.'
is_location_specificintIndicates 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_secondsfloatThe maximum time (in seconds) that the merchant can set for completing the payout. Relevant when is_expirable is true.
minimum_expiration_secondsfloatThe minimum time (in seconds) that the merchant can set for completing the payout. Relevant when is_expirable is true.
namestrPayout method name.
payout_currenciesList[str]A list of the currencies supported by this payout method. Three-letter ISO 4217 code. Uppercase. Response only.
payout_method_typestrThe type of payout method. The two-letter prefix must match the beneficiary country code. Required when default_payout_method_type is not used.
sender_countrystr
sender_currenciesList[str]List of currencies that the sender is paying with. Currency consists of a three-letter ISO 4217 code. Response only.
sender_entity_typesList[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_arrivalstrThe estimated time period in which the beneficiary will receive the funds.
statusintIndicates whether the payout method is currently available. One of the following values: 0 - Not available. 1 - Available.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →