@bebapps/rapyd-sdk/src/generated/wallet/types/Wallet.ts

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

import { WalletContact } from './WalletContact';

export interface Wallet {
  /**
   * Unique identifier of the wallet object. String starting with **ewallet_**.
   */
  id: `ewallet_${string}`;
  /**
   * An array of objects with the following fields:
   * - `id` - ID of the account. UUID.
   * - `alias` - Three-letter ISO 4217 code for the currency of the account.
   * - `balance` - Available funds in the account.
   * - `currency` - Three-letter ISO 4217 code for the currency used in the `balance` field. Uppercase.
   * - `limit` - Reserved.
   * - `limits` - Reserved.
   * - `on_hold_balance` - Amount in the on-hold balance of the account.
   * - `received_balance` - Amount  of escrow funds in the account.
   * - `reserve_balance` - Amount  in the reserve balance of the account.
   * 
   * Response only.
   */
  accounts: ({ id: unknown; alias: unknown; balance: unknown; currency: unknown; limit: unknown; limits: unknown; on_hold_balance: unknown; received_balance: unknown; reserve_balance: unknown })[];
  /**
   * Indicates the type of client wallet. One of the following:
   * - **collect**
   * - **disburse**
   * - **card_authorization**
   * - **general**
   * Relevant to client wallets. Read-only.
   */
  category: 'collect' | 'disburse' | 'card_authorization' | 'general';
  /**
   * Describes details about the wallet contacts. See [Wallet Contact Object](ref:wallet-contact-object). A 'person' wallet can have only one contact.
   * Contains the following fields:
   * 
   * - `data` - An array of ‘contact’ objects.  See [Wallet Contact](ref:wallet-contact).
   * 
   * - `has_more` - Boolean. Indicates whether there are more contacts than appear in the ‘data’ array.
   * 
   * - `total_count` - Number. The total number of contacts in the wallet.
   * 
   * - `url` - String. URL to retrieve all contacts in the wallet. Use HTTP GET.
   * 
   * Response only.
   */
  contacts: (Partial<WalletContact>)[] | { data: unknown; has_more: unknown; total_count: unknown; url: unknown };
  /**
   * Email address of the wallet owner.
   */
  email: string;
  /**
   * Wallet ID defined by the customer or end user. Must be unique.
   */
  ewallet_reference_id: string;
  /**
   * First name of the wallet owner.
   */
  first_name: string;
  /**
   * Family name of the wallet owner.
   */
  last_name: string;
  /**
   * A JSON object defined by the client.
   */
  metadata: object;
  /**
   * Phone number of the wallet owner in E.164 format.
   */
  phone_number: string;
  /**
   * Status of the wallet. One of the following:
   * - **ACT** - Active.
   * - **DIS** - Disabled.
   * 
   * Response only.
   */
  status: 'ACT' | 'DIS';
  /**
   * Type of wallet. One of the following:
   * - **company** - Indicates a business wallet. 
   * - **person** - Indicates the wallet of an individual consumer. 
   * - **client** - Indicates a wallet for the Rapyd client. Contact Rapyd support to create this type of wallet.
   */
  type: 'company' | 'person' | 'client';
  /**
   * Result of the verification check. One of the following:
   * - **not verified** - The contact has not been submitted for the Know Your Customer checks.
   * - **KYCd** - The user has passed the Know Your Customer checks.
   * 
   * Response only.
   */
  verification_status: 'not verified' | 'KYCd';
};