@circle-fin/circle-sdk/src/generated/models/business-recipient-address-object.ts

Node.js SDK for Circle API

/* tslint:disable */
/* eslint-disable */
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

// May contain unused imports in some cases
// @ts-ignore
import { Chain } from "./chain";
// May contain unused imports in some cases
// @ts-ignore
import { Currency } from "./currency";

/**
 *
 * @export
 * @interface BusinessRecipientAddressObject
 */
export interface BusinessRecipientAddressObject {
  /**
   * Unique system generated identifier for the entity.
   * @type {string}
   * @memberof BusinessRecipientAddressObject
   */
  id?: string;
  /**
   * An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address.
   * @type {string}
   * @memberof BusinessRecipientAddressObject
   */
  address?: string;
  /**
   * The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.
   * @type {string}
   * @memberof BusinessRecipientAddressObject
   */
  addressTag?: string | null;
  /**
   *
   * @type {Chain}
   * @memberof BusinessRecipientAddressObject
   */
  chain?: Chain;
  /**
   *
   * @type {Currency}
   * @memberof BusinessRecipientAddressObject
   */
  currency?: Currency | null;
  /**
   * An identifier or sentence that describes the recipient.
   * @type {string}
   * @memberof BusinessRecipientAddressObject
   */
  description?: string;
  /**
   *
   * @type {string}
   * @memberof BusinessRecipientAddressObject
   */
  status?: BusinessRecipientAddressObjectStatusEnum;
}

export const BusinessRecipientAddressObjectStatusEnum = {
  Active: "active",
  PendingVerification: "pending_verification",
  VerificationSucceeded: "verification_succeeded"
} as const;

export type BusinessRecipientAddressObjectStatusEnum =
  typeof BusinessRecipientAddressObjectStatusEnum[keyof typeof BusinessRecipientAddressObjectStatusEnum];