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

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

export interface BeneficiaryTokenizationPage {
  /**
   * - In [Create Beneficiary Tokenization Page](ref:create-beneficiary-tokenization-page): ID of the beneficiary tokenization page. String starting with **hp\_ben\_**.
   * 
   * - In [Retrieve Beneficiary ID](ref:retrieve-beneficiary-id): ID of the beneficiary. String starting with **beneficiary_**.
   */
  id: `beneficiary_${string}`;
  /**
   * The two-letter ISO 3166-1 ALPHA-2 code for the beneficiary’s country. Uppercase.
   */
  beneficiary_country: string;
  /**
   * Currency accepted by the beneficiary’s bank account. Three-letter ISO 4217 code. Uppercase.
   */
  beneficiary_currency: string;
  /**
   * Type of entity for the beneficiary. One of the following: 
   * - **individual**
   * - **company**
   */
  beneficiary_entity_type: 'individual' | 'company';
  /**
   * ID of the beneficiary. String starting with **beneficiary_**.
   */
  beneficiary_id: `beneficiary_${string}`;
  /**
   * Additional information about the beneficiary. See **beneficiary_optional_fields Object**, below.
   */
  beneficiary_optional_fields: object;
  /**
   * Indicates whether the beneficiary has been validated. See [Validate Beneficiary](ref:validate-beneficiary).
   */
  beneficiary_validated: boolean;
  /**
   * URL where the customer is redirected when the customer closes the beneficiary tokenization page before completing the operation. This URL overrides the fallback URL that was set in the Client Portal.
   */
  cancel_url: string;
  /**
   * The category of payout method. One of the following: 
   * - **bank**
   * - **card** - US only.
   */
  category: 'bank' | 'card';
  /**
   * URL where the customer is redirected when tokenization is successful. This URL overrides the fallback URL that was set in the Client Portal.
   */
  complete_url: string;
  /**
   * The two-letter ISO 3166-1 ALPHA-2 code for the beneficiary’s country. Uppercase.
   */
  country: string;
  /**
   * Currency accepted by the beneficiary’s bank account. Three-letter ISO 4217 code. Uppercase. Response only.
   */
  currency: string;
  /**
   * Type of entity for the beneficiary. One of the following: 
   * - **individual**
   * - **company**
   */
  entity_type: 'individual' | 'company';
  /**
   * The page expiration date in [*Unix time*](ref:glossary). Response only.
   */
  expiration: number;
  /**
   * Determines the default language of the hosted page. 
   * The values are documented in [Hosted Page Language Support](ref:hosted-page-language-support).
   */
  language: string;
  /**
   * Contact details for customer support, containing the following fields:
   * - `email` - Email address.
   * - `url` - URL for the client's customer support service.
   * - `phone_number` - Phone number for contacting the client's customer support service.
   * 
   * To configure these fields, use the Client Portal.
   */
  merchant_customer_support: { email: unknown; url: unknown; phone_number: unknown };
  /**
   * Identifier for the beneficiary. Defined by the client.
   */
  merchant_reference_id: string;
  /**
   * The page expiration date in [*Unix time*](ref:glossary). The default is 14 days from the creation of the page.
   */
  page_expiration: number;
  /**
   * Currency accepted by the beneficiary’s bank account. Three-letter ISO 4217 code. Uppercase.
   */
  payout_currency: string;
  /**
   * The payout method type selected by the customer.
   */
  payout_method_type: string;
  /**
   * List of payout methods that are excluded from display on the beneficiary tokenization page.
   */
  payout_method_types_exclude: (string)[];
  /**
   * Array of strings. List of payout methods that are displayed on the beneficiary tokenization page.
   */
  payout_method_types_include: (string)[];
  /**
   * URL where the customer is redirected for entering details.
   */
  redirect_url: string;
  /**
   * The two-letter ISO 3166-1 ALPHA-2 code for the sender’s country. Uppercase.
   */
  sender_country: string;
  /**
   * Currency paid from the sender’s wallet. Three-letter ISO 4217 code. Uppercase.
   */
  sender_currency: string;
  /**
   * Type of entity for the sender. One of the following: 
   * - **individual**
   * - **company**.
   */
  sender_entity_type: 'individual' | 'company';
  /**
   * Indicates whether the page was created successfully. One of the following values:
   * - **NEW** - New beneficiary.
   * - **SUCCESS** - Created.
   * - **ERROR** - Failed.
   */
  status: 'NEW' | 'SUCCESS' | 'ERROR';
  /**
   * Timestamp for the request to create the beneficiary tokenization object page, in [*Unix time*](ref:glossary). Response only.
   */
  timestamp: string;
  /**
   * ID of the beneficiary tokenization page. String starting with **hp\_ben\_**.
   */
  tokenization_page: string;
};