@bebapps/rapyd-sdk
Version:
An un-official [Rapyd](https://rapyd.net) SDK for Node.js.
47 lines (46 loc) • 1.32 kB
text/typescript
export interface CreateBeneficiaryRequest {
/**
* The category of payout method type. One of the following: **bank**, **card**, **cash**, **ewallet**, **rapyd_ewallet**
*/
category: string;
/**
* Name of the beneficiary company. Relevant when `entity_type` is **company**.
*/
company_name?: string;
/**
* Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase.
*/
country: string;
/**
* Currency received by the beneficiary. Three-letter ISO 4217 code. Uppercase.
*/
currency: string;
/**
* The default type of payout method for the beneficiary.
*/
default_payout_method_type?: string;
/**
* Type of entity for the beneficiary. One of the following: **individual**, **company**
*/
entity_type: string;
/**
* First name of the beneficiary. Relevant when `entity_type` is **individual**.
*/
first_name?: string;
/**
* Type of identification document for the beneficiary.
*/
identification_type?: string;
/**
* Identification number on the document mentioned in `identification_type`.
*/
identification_value?: string;
/**
* Family name of the beneficiary. Relevant when `entity_type` is **individual**.
*/
last_name?: string;
/**
* ID defined by the client.
*/
merchant_reference_id?: string;
};