Skip to main content

PayoutMethodTypeDetails

Properties

NameTypeRequiredDescription
batch_file_headerstrconcatenation of all fields.
beneficiary_countrystr
beneficiary_entity_typeEntityType
beneficiary_required_fieldsList[PayoutRequiredFields]Lists all the beneficiary required fields for payout method
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 location specific. 1 - location specific.'
is_onlineboolIndicates whether the payout is made automatically, without any action by the beneficiary.
maximum_amountfloatMaximum amount supported by this payout method for the indicated currency. Decimal number.
maximum_expiration_secondsfloatThe maximum time (in seconds) that the merchant can set for completing the payout. Relevant when is_expirable is true.
minimum_amountfloatMinimum amount supported by this payout method for the indicated currency. Decimal number.
minimum_expiration_secondsfloatThe minimum time (in seconds) that the merchant can set for completing the payout. Relevant when is_expirable is true.
payout_currencystr
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.
payout_optionsList[PayoutRequiredFields]Lists all the payout options for payout method
sender_countrystr
sender_currencystr
sender_entity_typeEntityType
sender_required_fieldsList[PayoutRequiredFields]Lists all the sender required fields for payout method
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 →