@bebapps/rapyd-sdk/src/generated/disburse/types/Beneficiary.ts

An un-official [Rapyd](https://rapyd.net) SDK for Node.js.

export interface Beneficiary {
  /**
   * ID of the 'beneficiary' object. String starting with **beneficiary_**. Response only.
   */
  id: `beneficiary_${string}`;
  /**
   * Maximum payout amount to validate, in units of the currency defined in `sender_currency`. Decimal.
   */
  amount: number;
  /**
   * ID of the 'beneficiary' object. String starting with **beneficiary_**.
   */
  beneficiary: `beneficiary_${string}`;
  /**
   * The category of payout method type. One of the following:
   * - **bank**
   * - **card**
   * - **cash**
   * - ** ewallet** - non-Rapyd eWallet
   * - **rapyd_ewallet** - Rapyd wallet
   * 
   * Must match the category of the payout method.
   */
  category: 'bank' | 'card' | 'cash' | 'ewallet' | 'rapyd_ewallet';
  /**
   * 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. Use [List Payout Method Types](ref:list-payout-method-types) for a list of supported types for a country.
   */
  default_payout_method_type: string;
  /**
   * Indicates whether a request to delete a beneficiary from the Rapyd platform succeeded. Response only.
   */
  deleted: boolean;
  /**
   * Type of entity. One of the following values:
   * - **individual**
   * - **company**
   */
  entity_type: 'individual' | 'company';
  /**
   * First name of the beneficiary. Relevant when `entity_type` is **individual**.
   */
  first_name: string;
  /**
   * Type of identification document for the beneficiary. When `entity_type` is **company**, this field must be **company_registered_number**. 
   * When `entity_type` is **individual**, one of the following values:
   * - **drivers_license**
   * - **identification_id**
   * - **international_passport**
   * - **residence_permit**
   * - **social_security**
   * - **work_permit**
   */
  identification_type: 'drivers_license' | 'identification_id' | 'international_passport' | 'residence_permit' | 'social_security' | 'work_permit';
  /**
   * Identification number on the document mentioned in `identification_type`.
   */
  identification_value: string;
  /**
   * Last name of the beneficiary. Relevant when `entity_type` is **individual**.
   */
  last_name: string;
  /**
   * ID defined by the merchant. Rapyd does not validate this value to enforce uniqueness.
   */
  merchant_reference_id: string;
  /**
   * The `type` of the payout method. Set to a value in the response to [List Payout Method Types](ref:list-payout-method-types).
   */
  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;
  /**
   * Type of entity for the sender. One of the following: **individual**, **company**
   */
  sender_entity_type: string;
  /**
   * Indicates whether the format of payout beneficiary details is valid for the payout method type. Response only.
   */
  validated: boolean;
};