@circle-fin/circle-sdk
Version:
Node.js SDK for Circle API
68 lines (67 loc) • 1.97 kB
TypeScript
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { FiatMoneyUsd } from "./fiat-money-usd";
/**
* Return information if the payout is returned by bank. Only present if `errorCode` of payout is `transaction_returned`.
* @export
* @interface UnwithdrawalObject
*/
export interface UnwithdrawalObject {
/**
* Unique system generated identifier for the entity.
* @type {string}
* @memberof UnwithdrawalObject
*/
id?: string;
/**
* Universally unique identifier (UUID v4) of the payout that is associated with the return.
* @type {string}
* @memberof UnwithdrawalObject
*/
payoutId?: string;
/**
*
* @type {FiatMoneyUsd}
* @memberof UnwithdrawalObject
*/
amount?: FiatMoneyUsd;
/**
*
* @type {FiatMoneyUsd}
* @memberof UnwithdrawalObject
*/
fees?: FiatMoneyUsd;
/**
* Reason for the return.
* @type {string}
* @memberof UnwithdrawalObject
*/
reason?: string;
/**
* Status of the return. A `pending` status indicates that the return is in process; `complete` indicates it finished successfully; `failed` indicates it failed.
* @type {string}
* @memberof UnwithdrawalObject
*/
status?: UnwithdrawalObjectStatusEnum;
/**
* ISO-8601 UTC date/time format.
* @type {string}
* @memberof UnwithdrawalObject
*/
createDate?: string;
/**
* ISO-8601 UTC date/time format.
* @type {string}
* @memberof UnwithdrawalObject
*/
updateDate?: string;
}
export declare const UnwithdrawalObjectStatusEnum: {
readonly Pending: "pending";
readonly Complete: "complete";
readonly Failed: "failed";
};
export declare type UnwithdrawalObjectStatusEnum = typeof UnwithdrawalObjectStatusEnum[keyof typeof UnwithdrawalObjectStatusEnum];