@circle-fin/circle-sdk
Version:
Node.js SDK for Circle API
103 lines (102 loc) • 2.81 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 { CancelRefundReversalStatus } from "./cancel-refund-reversal-status";
import { FiatMoneyUsd } from "./fiat-money-usd";
import { PaymentInfoPaymentAndRefund } from "./payment-info-payment-and-refund";
import { SourceResponse } from "./source-response";
/**
* Status information of the related cancel. This property is only present on canceled payment or refund items.
* @export
* @interface FiatCancel
*/
export interface FiatCancel {
/**
* Unique system generated identifier for the entity.
* @type {string}
* @memberof FiatCancel
*/
id: string;
/**
* Type of the payment object.
* @type {string}
* @memberof FiatCancel
*/
type: FiatCancelTypeEnum;
/**
* Unique system generated identifier for the merchant.
* @type {string}
* @memberof FiatCancel
*/
merchantId: string;
/**
* Unique system generated identifier for the wallet of the merchant.
* @type {string}
* @memberof FiatCancel
*/
merchantWalletId?: string;
/**
*
* @type {FiatMoneyUsd}
* @memberof FiatCancel
*/
amount: FiatMoneyUsd;
/**
*
* @type {SourceResponse}
* @memberof FiatCancel
*/
source: SourceResponse;
/**
* Enumerated description of the payment.
* @type {string}
* @memberof FiatCancel
*/
description?: FiatCancelDescriptionEnum;
/**
*
* @type {CancelRefundReversalStatus}
* @memberof FiatCancel
*/
status: CancelRefundReversalStatus;
/**
*
* @type {PaymentInfoPaymentAndRefund}
* @memberof FiatCancel
*/
originalPayment?: PaymentInfoPaymentAndRefund;
/**
*
* @type {FiatMoneyUsd}
* @memberof FiatCancel
*/
fees?: FiatMoneyUsd;
/**
* The channel identifier that can be set for the payment. When not provided, the default channel is used.
* @type {string}
* @memberof FiatCancel
*/
channel?: string;
/**
* ISO-8601 UTC date/time format.
* @type {string}
* @memberof FiatCancel
*/
createDate?: string;
/**
* ISO-8601 UTC date/time format.
* @type {string}
* @memberof FiatCancel
*/
updateDate?: string;
}
export declare const FiatCancelTypeEnum: {
readonly Cancel: "cancel";
};
export declare type FiatCancelTypeEnum = typeof FiatCancelTypeEnum[keyof typeof FiatCancelTypeEnum];
export declare const FiatCancelDescriptionEnum: {
readonly Payment: "Payment";
};
export declare type FiatCancelDescriptionEnum = typeof FiatCancelDescriptionEnum[keyof typeof FiatCancelDescriptionEnum];