@bebapps/rapyd-sdk/src/generated/collect/types/HostedPageCardToken.ts

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

export interface HostedPageCardToken {
  /**
   * ID of the Hosted Page Card Token object, a string starting with **hp\_card\_**. Response only.
   */
  id: string;
  /**
   * Indicates whether the hosted page displays address fields to fill in. 
   * - **true** - The fields are displayed. 
   * - **false** - The fields are displayed only for country codes **US**, **GB** and **CA**.  This is the default.
   */
  billing_address_collect: boolean;
  /**
   * URL where the customer is redirected after pressing **Back to Website** to exit the hosted page. This URL overrides the `merchant_website` URL.
   */
  cancel_url: string;
  /**
   * Reserved. Response only.
   */
  cards: (string)[];
  /**
   * Category of payment method:  **card**. Response only.
   */
  category: string;
  /**
   * URL where the customer is redirected after pressing **Close** to exit the hosted page. This URL overrides the `merchant_website` URL.
   */
  complete_url: string;
  /**
   * The two-letter ISO 3166-1 ALPHA-2 code for the country.
   */
  country: string;
  /**
   * When specified in the request, defines a currency that is not the country's default currency. 
   * When not specified in the request, the country's default currency. 
   * Three-letter ISO 4217 code.
   */
  currency: string;
  /**
   * ID of the customer, a string starting with **cus_**.
   * 
   * For more information, see [Customer Object](ref:customer-object).
   */
  customer: `cus_${string}`;
  /**
   * Time when the hosted page URL expires, in [*Unix time*](ref:glossary). 14 days after creation of the page. Response only.
   */
  expiration: number;
  /**
   * Determines the default language of the hosted page. 
   * The values are listed on [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. 
   * 
   * Response only.
   * 
   * To configure these fields, use the Client Portal. See [Customizing Your Hosted Page](https://docs.rapyd.net/client-portal/docs/customizing-your-hosted-page).
   */
  merchant_customer_support: { email: unknown; url: unknown; phone_number: unknown };
  /**
   * The URL where the customer is redirected after exiting the hosted page. 
   * 
   * Relevant when one or both of the following fields is unset:  
   * - `cancel_url`
   * - `complete_url`
   * 
   * Response only.
   * 
   * To configure this field, use the **Fallback URL** field in the Client Portal. See [Customizing Your Hosted Page](https://docs.rapyd.net/client-portal/docs/customizing-your-hosted-page).
   */
  merchant_website: string;
  /**
   * Limits the page to a specific type of payment method. For example, **dk_visa_card**. For a list of payment methods, use [List Payment Methods by Country](ref:list-payment-methods-by-country).
   */
  payment_method_type: string;
  /**
   * Reserved. Response only.
   */
  payment_method_types: (string)[];
  /**
   * Reserved. Contains the following fields:
   * - `complete_payment_url` 
   * - `error_payment_url` 
   * 
   * Response only.
   */
  payment_params: { complete_payment_url: unknown; error_payment_url: unknown };
  /**
   * URL of the hosted page. Response only.
   */
  redirect_url: string;
  /**
   * Status of the hosted page. One of the following:
   * - **NEW** - The page was created.
   * - **DONE** - A card was added.
   * 
   * Response only.
   */
  status: 'NEW' | 'DONE';
  /**
   * Time when the hosted page is created, in [*Unix time*](ref:glossary). Response only.
   */
  timestamp: number;
};