@bebapps/rapyd-sdk
Version:
An un-official [Rapyd](https://rapyd.net) SDK for Node.js.
43 lines (42 loc) • 1.43 kB
text/typescript
export interface GetPayoutRequiredFieldsRequest {
/**
* The type of the payout method. Set to the name of a payout method listed in the response to [List Payout Method Types](ref:list-payout-method-types).
*/
payout_method_type: string;
/**
* Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase.
*/
beneficiary_country: string;
/**
* Type of entity for the beneficiary. One of the following: **individual**, **company**
*/
beneficiary_entity_type: string;
/**
* The identifier code of the bank. Required when ‘payout_method_type’ is not used.
*/
identifier_type?: string;
/**
* The identifier value for the code of the bank entered in `identifier_type`. Required when ‘payout_method_type’ is not used.
*/
identifier_value?: string;
/**
* Amount of the payout, in units of the currency that the beneficiary is receiving. Decimal.
*/
payout_amount: number;
/**
* Currency received by the beneficiary. Three-letter ISO 4217 code. Uppercase.
*/
payout_currency: 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;
/**
* Type of entity for the sender. One of the following: **individual**, **company**
*/
sender_entity_type: string;
};