@circle-fin/circle-sdk/src/generated/models/payment-intent-creation-request.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 { CryptoPaymentsMoney } from "./crypto-payments-money";
// May contain unused imports in some cases
// @ts-ignore
import { PaymentMethodBlockchain } from "./payment-method-blockchain";

/**
 *
 * @export
 * @interface PaymentIntentCreationRequest
 */
export interface PaymentIntentCreationRequest {
  /**
   * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
   * @type {string}
   * @memberof PaymentIntentCreationRequest
   */
  idempotencyKey: string;
  /**
   *
   * @type {CryptoPaymentsMoney}
   * @memberof PaymentIntentCreationRequest
   */
  amount: CryptoPaymentsMoney;
  /**
   * Desired currency for the payments to settle in.
   * @type {string}
   * @memberof PaymentIntentCreationRequest
   */
  settlementCurrency: PaymentIntentCreationRequestSettlementCurrencyEnum;
  /**
   *
   * @type {Array<PaymentMethodBlockchain>}
   * @memberof PaymentIntentCreationRequest
   */
  paymentMethods: Array<PaymentMethodBlockchain>;
  /**
   * Unique system generated identifier for the wallet of the merchant.
   * @type {string}
   * @memberof PaymentIntentCreationRequest
   */
  merchantWalletId?: string;
}

export const PaymentIntentCreationRequestSettlementCurrencyEnum = {
  Usd: "USD",
  Btc: "BTC",
  Eth: "ETH"
} as const;

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