@bebapps/rapyd-sdk
Version:
An un-official [Rapyd](https://rapyd.net) SDK for Node.js.
176 lines (175 loc) • 6.34 kB
text/typescript
export interface PayoutMethodType {
/**
* 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.
*/
amount_range_per_currency: { maximum_amount: unknown; minimum_amount: unknown; payout_currency: unknown };
/**
* Contains a comma-separated list of the headers required for creating a batch file. Relevant for creating a mass payout through the Client Portal.
*/
batch_file_header: string;
/**
* Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase.
*/
beneficiary_country: string;
/**
* Filters the type of entity for the beneficiary. One of the following:
* * **company**
* * **individual**
*
* Relevant to [List Payout Method Types](ref:list-payout-method-types).
*/
beneficiary_entity_type: 'company' | 'individual';
/**
* A list of the beneficiary entity types supported by this payout method. One or more of the following:
* * **company**
* * **individual**
*/
beneficiary_entity_types: ('company' | 'individual')[];
/**
* Describes the fields required for the beneficiary when you create a payout. Two or more of the following:
* * `name` - Name of the field.
* * `regex` - A regular expression that defines the valid values for the field.
* * `type` - Type of data for the field.
* * `description` - Text description of the field.
*/
beneficiary_required_fields: (string)[];
/**
* The category of payout method type. One of the following:
* * **bank**
* * **card**
* * **cash**
* * ** ewallet** - non-Rapyd eWallet
* * **rapyd_ewallet** - Rapyd wallet
*/
category: 'bank' | 'card' | 'cash' | 'ewallet' | 'rapyd_ewallet';
/**
* ID of the payout object after the last one in the list. String starting with **payout_**.
*/
ending_before: `payout_${string}`;
/**
* Indicates the type of the bank ID number. Possible values:
* - **bic**
* - **bicswift**
* - Country-specific types with the two-letter country abbreviation as a suffix. For example, **bic_tw**.
*
* Required when `payout_method_type` is not used.
*/
identifier_type: string;
/**
* The bank ID number. Required when `payout_method_type` is not used.
*/
identifier_value: number;
/**
* URL of an image that the merchant can use to represent the payout method.
*/
image: string;
/**
* Indicates whether the payout can be canceled. Relevant when `category` is **cash**.
*/
is_cancelable: boolean;
/**
* Indicates whether the payout expires if not completed. Relevant when `category` is **cash**.
*/
is_expirable: boolean;
/**
* Indicates whether the payout must be made at a specific physical location. Relevant when `category` is **cash**.
*/
is_location_specific: boolean;
/**
* Indicates whether the payout is made automatically, without any action by the beneficiary.
*/
is_online: boolean;
/**
* Maximum number of payout object IDs to return. Integer.
*/
limit: number;
/**
* Maximum amount supported by this payout method for the indicated currency. Decimal number.
*/
maximum_amount: number;
/**
* The maximum time (in seconds) that the merchant can set for completing the payout. Relevant when `is_expirable` is **true**.
*/
maximum_expiration_seconds: number;
/**
* A JSON object defined by the client.
*/
metadata: object;
/**
* Minimum amount supported by this payout method for the indicated currency. Decimal number.
*/
minimum_amount: number;
/**
* The minimum time (in seconds) that the merchant can set for completing the payout. Relevant when `is_expirable` is **true**.
*/
minimum_expiration_seconds: number;
/**
* Payout method name.
*/
name: string;
/**
* Amount of the payout, in units of the currency defined in `payout_currency`. Mandatory when `sender_amount` is not used. Decimal.
*/
payout_amount: number;
/**
* Currency received by the beneficiary. Three-letter ISO 4217 code. Uppercase.
*/
payout_currency: string;
/**
* A list of the currencies supported by this payout method. Three-letter ISO 4217 code. Uppercase.
*/
payout_currencies: (string)[];
/**
* The type of payout method. Required when `identifier_type` and `default_payout_method_type` are not used.
*/
payout_method_type: string;
/**
* Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase.
*/
sender_country: string;
/**
* Currency that the sender is paying with. Three-letter ISO 4217 code. Uppercase.
*/
sender_currency: string;
/**
* List of currencies that the sender is paying with. Currency consists of a three-letter ISO 4217 code. Uppercase.
*/
sender_currencies: object;
/**
* Filters the type of entity for the sender. One of the following:
* * **company**
* * **individual**
*
* Relevant to [List Payout Method Types](ref:list-payout-method-types).
*/
sender_entity_type: 'company' | 'individual';
/**
* A list of the sender entity types supported by this payout method. One or more of the following:
* * **company**
* * **individual**
*/
sender_entity_types: ('company' | 'individual')[];
/**
* Describes the fields required for the sender when you create a payout. Two or more of the following:
* * `name` - Name of the field.
* * `regex` - A regular expression that defines the valid values for the field.
* * `type` - Type of data for the field.
* * `description` - Text description of the field.
*/
sender_required_fields: (string)[];
/**
* ID of the payout object before the first one in the list. String starting with **payout_**.
*/
starting_after: `payout_${string}`;
/**
* Indicates whether the payout method is currently available. One of the following values:
* * **0** - Not available.
* * **1** - Available.
*
* Relevant to [List Payout Method Types](ref:list-payout-method-types).
*/
status: boolean;
};