@circle-fin/circle-sdk
Version:
Node.js SDK for Circle API
59 lines (56 loc) • 1.89 kB
text/typescript
/* 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";
/**
* Adds a recipient address. The currency parameter will default to USD for all chains except for BTC where it defaults to BTC.
* @export
* @interface BusinessRecipientAddressCreationRequest
*/
export interface BusinessRecipientAddressCreationRequest {
/**
* Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
* @type {string}
* @memberof BusinessRecipientAddressCreationRequest
*/
idempotencyKey: 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 BusinessRecipientAddressCreationRequest
*/
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 BusinessRecipientAddressCreationRequest
*/
addressTag?: string | null;
/**
*
* @type {Chain}
* @memberof BusinessRecipientAddressCreationRequest
*/
chain: Chain;
/**
*
* @type {Currency}
* @memberof BusinessRecipientAddressCreationRequest
*/
currency?: Currency | null;
/**
* An identifier or sentence that describes the recipient.
* @type {string}
* @memberof BusinessRecipientAddressCreationRequest
*/
description: string;
}