@enfuce/nextgen-sdk 0.0.1

package/dist/esm/transaction-event/api.d.ts

@@ -0,0 +1,1082 @@
+/**
+ * Transaction events API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ApprovedTransaction
+ */
+export interface ApprovedTransaction {
+    /**
+     * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved.  In case of scheme advices, this is generated and transmitted by the scheme.
+     * @type {string}
+     * @memberof ApprovedTransaction
+     */
+    'authCode'?: string;
+    /**
+     * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
+     * @type {number}
+     * @memberof ApprovedTransaction
+     */
+    'authValidity'?: number;
+    /**
+     * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
+     * @type {Money}
+     * @memberof ApprovedTransaction
+     */
+    'billingAmount'?: Money;
+    /**
+     * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
+     * @type {Money}
+     * @memberof ApprovedTransaction
+     */
+    'transactionAmount'?: Money;
+    /**
+     * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
+     * @type {Money}
+     * @memberof ApprovedTransaction
+     */
+    'settlementAmount'?: Money;
+    /**
+     * Fee charged (for example, by the acquirer) for transaction activity.
+     * @type {Money}
+     * @memberof ApprovedTransaction
+     */
+    'acquirerTransactionFeeAmount'?: Money;
+    /**
+     *
+     * @type {Array<TransactionFee>}
+     * @memberof ApprovedTransaction
+     */
+    'issuerTransactionFees'?: Array<TransactionFee>;
+    /**
+     *
+     * @type {Array<CardholderVerificationMethod>}
+     * @memberof ApprovedTransaction
+     */
+    'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
+    /**
+     * Merchant/acquirer generated transaction reference number.
+     * @type {string}
+     * @memberof ApprovedTransaction
+     */
+    'retrievalReferenceNumber'?: string;
+    /**
+     *
+     * @type {CardEntryMode}
+     * @memberof ApprovedTransaction
+     */
+    'cardEntryMode'?: CardEntryMode;
+    /**
+     * Indicates whether the cardholder is physically present during transaction.
+     * @type {boolean}
+     * @memberof ApprovedTransaction
+     */
+    'cardholderPresent'?: boolean;
+    /**
+     * Indicates whether the card is present at the point of service.
+     * @type {boolean}
+     * @memberof ApprovedTransaction
+     */
+    'cardPresent'?: boolean;
+    /**
+     * Indicates whether the transaction is a recurring payment or merchant initiated.  This implies whether the cardholder has approved the merchant initiated transaction.
+     * @type {boolean}
+     * @memberof ApprovedTransaction
+     */
+    'merchantInitiated'?: boolean;
+    /**
+     * Date and time in the time zone where the transaction occurred.
+     * @type {string}
+     * @memberof ApprovedTransaction
+     */
+    'transactionDateTime'?: string;
+    /**
+     * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
+     * @type {string}
+     * @memberof ApprovedTransaction
+     */
+    'originalTransactionId'?: string;
+    /**
+     *
+     * @type {TransactionType}
+     * @memberof ApprovedTransaction
+     */
+    'transactionType'?: TransactionType;
+    /**
+     * Amount approved at the current payment processing stage; the amount might be further reduced in the subsequent stages, when the Ledger performs additional validations. If any issuer transaction fee is applied (see the issuerTransactionFees field), the approvedAmount also includes those fees.
+     * @type {Money}
+     * @memberof ApprovedTransaction
+     */
+    'approvedAmount'?: Money;
+    /**
+     * Time when processed by Enfuce.
+     * @type {string}
+     * @memberof ApprovedTransaction
+     */
+    'processedDateTime'?: string;
+}
+/**
+ * Information about the card used for the payment.
+ * @export
+ * @interface Card
+ */
+export interface Card {
+    /**
+     * Enfuce generated unique ID assigned to each card used — enables you to identify the card that you must authorise.
+     * @type {string}
+     * @memberof Card
+     */
+    'id'?: string;
+    /**
+     * Card expiration date as received in the scheme message.
+     * @type {Expiration}
+     * @memberof Card
+     */
+    'expirationDate'?: Expiration;
+    /**
+     * Card sequence number as received in the scheme message.
+     * @type {number}
+     * @memberof Card
+     */
+    'sequenceNumber'?: number;
+    /**
+     * Ledger provided account ID associated with the card.
+     * @type {string}
+     * @memberof Card
+     */
+    'accountId'?: string;
+    /**
+     * Unique ID of the cardholder associated with the card.
+     * @type {string}
+     * @memberof Card
+     */
+    'cardholderId'?: string;
+    /**
+     * Information about any parent card group associated with the card.
+     * @type {Array<CardGroupsInner>}
+     * @memberof Card
+     */
+    'groups'?: Array<CardGroupsInner>;
+    /**
+     * The type of card application used for the transaction.
+     * @type {string}
+     * @memberof Card
+     */
+    'applicationSelection'?: CardApplicationSelectionEnum;
+}
+export declare const CardApplicationSelectionEnum: {
+    readonly Debit: "DEBIT";
+    readonly Credit: "CREDIT";
+};
+export type CardApplicationSelectionEnum = typeof CardApplicationSelectionEnum[keyof typeof CardApplicationSelectionEnum];
+/**
+ * Describes how the card credentials were captured.
+ * @export
+ * @enum {string}
+ */
+export declare const CardEntryMode: {
+    readonly Chip: "CHIP";
+    readonly ChipContactless: "CHIP_CONTACTLESS";
+    readonly MagneticStripe: "MAGNETIC_STRIPE";
+    readonly ManualEntry: "MANUAL_ENTRY";
+    readonly WalletContactless: "WALLET_CONTACTLESS";
+    readonly Ecommerce: "ECOMMERCE";
+    readonly WalletEcommerce: "WALLET_ECOMMERCE";
+    readonly CredentialsOnFile: "CREDENTIALS_ON_FILE";
+    readonly Unknown: "UNKNOWN";
+};
+export type CardEntryMode = typeof CardEntryMode[keyof typeof CardEntryMode];
+/**
+ *
+ * @export
+ * @interface CardGroupsInner
+ */
+export interface CardGroupsInner {
+    /**
+     * Unique ID assigned to the parent card group.
+     * @type {string}
+     * @memberof CardGroupsInner
+     */
+    'groupId': string;
+}
+/**
+ * The method used for verifying the cardholder: - PIN_VERIFIED_BY_CARD: The card\'s PIN is verified. - PIN_VERIFIED_BY_ISSUER: The card\'s PIN is verified by issuer. - WALLET: The cardholder is verified by the digital wallet. - THREE_DS: The cardholder is 3DS authenticated. - BIOMETRIC: The cardholder is verified by biometrics data. - SIGNATURE: The cardholder\'s signature verified. - NO_VERIFICATION: No verification is performed.
+ * @export
+ * @enum {string}
+ */
+export declare const CardholderVerificationMethod: {
+    readonly PinVerifiedByCard: "PIN_VERIFIED_BY_CARD";
+    readonly PinVerifiedByIssuer: "PIN_VERIFIED_BY_ISSUER";
+    readonly Wallet: "WALLET";
+    readonly ThreeDs: "THREE_DS";
+    readonly Biometric: "BIOMETRIC";
+    readonly Signature: "SIGNATURE";
+    readonly NoVerification: "NO_VERIFICATION";
+};
+export type CardholderVerificationMethod = typeof CardholderVerificationMethod[keyof typeof CardholderVerificationMethod];
+/**
+ * The status of the transaction. CLEARED means that the transaction has been fully cleared, PARTIALLY_CLEARED means that the transaction is partially cleared.
+ * @export
+ * @enum {string}
+ */
+export declare const ClearingStatus: {
+    readonly Cleared: "CLEARED";
+    readonly PartiallyCleared: "PARTIALLY_CLEARED";
+};
+export type ClearingStatus = typeof ClearingStatus[keyof typeof ClearingStatus];
+/**
+ * Field that contains exchange rates for the transaction, it is null if both currencies are the same.
+ * @export
+ * @interface ExchangeRates
+ */
+export interface ExchangeRates {
+    /**
+     * European Central Bank exchange rate.
+     * @type {number}
+     * @memberof ExchangeRates
+     */
+    'ecbRate'?: number;
+}
+/**
+ *
+ * @export
+ * @interface Expiration
+ */
+export interface Expiration {
+    /**
+     * Expiration year in YYYY format.
+     * @type {number}
+     * @memberof Expiration
+     */
+    'year': number;
+    /**
+     * Expiration month in MM format.
+     * @type {number}
+     * @memberof Expiration
+     */
+    'month': number;
+}
+/**
+ * Interchange calculated by the scheme for the transaction.
+ * @export
+ * @interface InterchangeFee
+ */
+export interface InterchangeFee {
+    /**
+     *
+     * @type {number}
+     * @memberof InterchangeFee
+     */
+    'amount': number;
+    /**
+     * A valid ISO 4217 currency code
+     * @type {string}
+     * @memberof InterchangeFee
+     */
+    'currency': string;
+    /**
+     *
+     * @type {InterchangeFeeDirection}
+     * @memberof InterchangeFee
+     */
+    'direction': InterchangeFeeDirection;
+}
+/**
+ * Specifies if the interchange fee amount is a credit or a debit for the cardholder.
+ * @export
+ * @enum {string}
+ */
+export declare const InterchangeFeeDirection: {
+    readonly Credit: "CREDIT";
+    readonly Debit: "DEBIT";
+    readonly Unknown: "UNKNOWN";
+};
+export type InterchangeFeeDirection = typeof InterchangeFeeDirection[keyof typeof InterchangeFeeDirection];
+/**
+ *
+ * @export
+ * @interface Merchant
+ */
+export interface Merchant {
+    /**
+     * ID assigned code each card acceptor, i.e. a merchant or a bank.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'id'?: string;
+    /**
+     * Merchant name as received from the card scheme. For ATMs, this can be a street address or a bank branch number.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'name'?: string;
+    /**
+     * The city where the transaction/withdrawal has occurred or where the merchant is registered.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'city'?: string;
+    /**
+     * The country where the transaction/withdrawal has occurred or where the merchant is registered.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'country'?: string;
+    /**
+     * The merchant\'s postal code.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'zipCode'?: string;
+    /**
+     * Contains the merchant\'s street address.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'address'?: string;
+    /**
+     *
+     * @type {MerchantCategory}
+     * @memberof Merchant
+     */
+    'category'?: MerchantCategory;
+    /**
+     * Uniquely ID assigned to each terminal used by the merchant.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'terminalId'?: string;
+    /**
+     * The sub-merchant ID is used when merchant ID is not adequate to identify the merchant.  Used when a merchant uses a payment facilitator.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'subMerchantId'?: string;
+    /**
+     * Indicates whether the merchant is capable of accepting partial approval of an amount:   - TRUE: Specifies `TRUE` if the merchant accepts partial approval.   - FALSE: Specifies `FALSE` if the merchant does not accept partial approval.
+     * @type {boolean}
+     * @memberof Merchant
+     */
+    'partialApprovalCapable'?: boolean;
+    /**
+     * Unique ID assigned to the financial institution acting as the merchant\'s acquirer.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'acquirerId'?: string;
+    /**
+     * The country of the merchant\'s acquirer — mention the ISO-3166-1 alpha-3 country code.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'acquirerCountry'?: string;
+    /**
+     * Data an acquirer supplies in an acquirer-originated message, might be required for the issuer  to return to the acquirer in a subsequent message.
+     * @type {string}
+     * @memberof Merchant
+     */
+    'acquirerReferenceData'?: string;
+}
+/**
+ *
+ * @export
+ * @interface MerchantCategory
+ */
+export interface MerchantCategory {
+    /**
+     * Merchant category code as per the card scheme classification. Categorisation is done based on the type of business or service the merchant provides.
+     * @type {string}
+     * @memberof MerchantCategory
+     */
+    'code'?: string;
+    /**
+     * Description of the Merchant Category Code (MCC).
+     * @type {string}
+     * @memberof MerchantCategory
+     */
+    'description'?: string;
+    /**
+     * Merchant Category Code (MCC) group as received from the scheme.
+     * @type {string}
+     * @memberof MerchantCategory
+     */
+    'group'?: string;
+}
+/**
+ * Message category sent in the transaction event webhook. Possible enums: - INITIAL_AUTHORIZATION: Initial authorisation of the card payment. - INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction. - DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode. - ADJUSTMENT: Corrections to a previously authorised transaction. - REVERSAL: Reversal of a previously authorised transaction. - BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application. - PIN_MANAGEMENT: Request to change the card PIN. - PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request. - FINANCIAL: Clearing message of batch payments. - PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period. - VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a `VOID_AUTHORIZATION` message is generated.
+ * @export
+ * @enum {string}
+ */
+export declare const MessageCategoryTransactionEvent: {
+    readonly InitialAuthorization: "INITIAL_AUTHORIZATION";
+    readonly IncrementalAuthorization: "INCREMENTAL_AUTHORIZATION";
+    readonly DeclinedAuthorization: "DECLINED_AUTHORIZATION";
+    readonly Adjustment: "ADJUSTMENT";
+    readonly Reversal: "REVERSAL";
+    readonly BalanceInquiry: "BALANCE_INQUIRY";
+    readonly PinManagement: "PIN_MANAGEMENT";
+    readonly PinManagementReversal: "PIN_MANAGEMENT_REVERSAL";
+    readonly Financial: "FINANCIAL";
+    readonly FinancialAddendum: "FINANCIAL_ADDENDUM";
+    readonly FeeCollection: "FEE_COLLECTION";
+    readonly Reconciliation: "RECONCILIATION";
+    readonly PurgeAuthorization: "PURGE_AUTHORIZATION";
+    readonly VoidAuthorization: "VOID_AUTHORIZATION";
+    readonly Chargeback: "CHARGEBACK";
+    readonly ChargebackReversal: "CHARGEBACK_REVERSAL";
+    readonly Representment: "REPRESENTMENT";
+    readonly RepresentmentReversal: "REPRESENTMENT_REVERSAL";
+    readonly DocumentRequest: "DOCUMENT_REQUEST";
+};
+export type MessageCategoryTransactionEvent = typeof MessageCategoryTransactionEvent[keyof typeof MessageCategoryTransactionEvent];
+/**
+ * Identifies the message function of the transaction event.
+ * @export
+ * @enum {string}
+ */
+export declare const MessageFunctionTransactionEvent: {
+    readonly Request: "REQUEST";
+    readonly Advice: "ADVICE";
+    readonly Notification: "NOTIFICATION";
+    readonly AccountStatusInquiry: "ACCOUNT_STATUS_INQUIRY";
+};
+export type MessageFunctionTransactionEvent = typeof MessageFunctionTransactionEvent[keyof typeof MessageFunctionTransactionEvent];
+/**
+ * Amount including currency.
+ * @export
+ * @interface Money
+ */
+export interface Money {
+    /**
+     *
+     * @type {number}
+     * @memberof Money
+     */
+    'amount': number;
+    /**
+     * A valid ISO 4217 currency code
+     * @type {string}
+     * @memberof Money
+     */
+    'currency': string;
+}
+/**
+ *
+ * @export
+ * @interface ProcessedTransaction
+ */
+export interface ProcessedTransaction {
+    /**
+     * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved.  In case of scheme advices, this is generated and transmitted by the scheme.
+     * @type {string}
+     * @memberof ProcessedTransaction
+     */
+    'authCode'?: string;
+    /**
+     * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
+     * @type {number}
+     * @memberof ProcessedTransaction
+     */
+    'authValidity'?: number;
+    /**
+     * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
+     * @type {Money}
+     * @memberof ProcessedTransaction
+     */
+    'billingAmount'?: Money;
+    /**
+     * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
+     * @type {Money}
+     * @memberof ProcessedTransaction
+     */
+    'transactionAmount'?: Money;
+    /**
+     * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
+     * @type {Money}
+     * @memberof ProcessedTransaction
+     */
+    'settlementAmount'?: Money;
+    /**
+     * Fee charged (for example, by the acquirer) for transaction activity.
+     * @type {Money}
+     * @memberof ProcessedTransaction
+     */
+    'acquirerTransactionFeeAmount'?: Money;
+    /**
+     *
+     * @type {Array<TransactionFee>}
+     * @memberof ProcessedTransaction
+     */
+    'issuerTransactionFees'?: Array<TransactionFee>;
+    /**
+     *
+     * @type {Array<CardholderVerificationMethod>}
+     * @memberof ProcessedTransaction
+     */
+    'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
+    /**
+     * Merchant/acquirer generated transaction reference number.
+     * @type {string}
+     * @memberof ProcessedTransaction
+     */
+    'retrievalReferenceNumber'?: string;
+    /**
+     *
+     * @type {CardEntryMode}
+     * @memberof ProcessedTransaction
+     */
+    'cardEntryMode'?: CardEntryMode;
+    /**
+     * Indicates whether the cardholder is physically present during transaction.
+     * @type {boolean}
+     * @memberof ProcessedTransaction
+     */
+    'cardholderPresent'?: boolean;
+    /**
+     * Indicates whether the card is present at the point of service.
+     * @type {boolean}
+     * @memberof ProcessedTransaction
+     */
+    'cardPresent'?: boolean;
+    /**
+     * Indicates whether the transaction is a recurring payment or merchant initiated.  This implies whether the cardholder has approved the merchant initiated transaction.
+     * @type {boolean}
+     * @memberof ProcessedTransaction
+     */
+    'merchantInitiated'?: boolean;
+    /**
+     * Date and time in the time zone where the transaction occurred.
+     * @type {string}
+     * @memberof ProcessedTransaction
+     */
+    'transactionDateTime'?: string;
+    /**
+     * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
+     * @type {string}
+     * @memberof ProcessedTransaction
+     */
+    'originalTransactionId'?: string;
+    /**
+     *
+     * @type {TransactionTypeClearing}
+     * @memberof ProcessedTransaction
+     */
+    'transactionType'?: TransactionTypeClearing;
+    /**
+     * Contains previous amounts in a Financial message that has been corrected, in transaction currency.
+     * @type {Money}
+     * @memberof ProcessedTransaction
+     */
+    'originalAmount'?: Money;
+    /**
+     * Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
+     * @type {string}
+     * @memberof ProcessedTransaction
+     */
+    'reconciliationDate'?: string;
+    /**
+     * Identifies a reconciliation period in a reconciliation date.
+     * @type {string}
+     * @memberof ProcessedTransaction
+     */
+    'reconciliationCycle'?: string;
+    /**
+     * Time when processed by Enfuce.
+     * @type {string}
+     * @memberof ProcessedTransaction
+     */
+    'processedDateTime'?: string;
+    /**
+     *
+     * @type {InterchangeFee}
+     * @memberof ProcessedTransaction
+     */
+    'interchangeFee'?: InterchangeFee;
+    /**
+     *
+     * @type {ExchangeRates}
+     * @memberof ProcessedTransaction
+     */
+    'exchangeRates'?: ExchangeRates;
+}
+/**
+ * Information about the token associated with the card.
+ * @export
+ * @interface Token
+ */
+export interface Token {
+    /**
+     *
+     * @type {string}
+     * @memberof Token
+     */
+    'id'?: string;
+    /**
+     * Identifies the specific digital wallet.
+     * @type {string}
+     * @memberof Token
+     */
+    'walletIdentifier'?: TokenWalletIdentifierEnum;
+}
+export declare const TokenWalletIdentifierEnum: {
+    readonly Masterpass: "MASTERPASS";
+    readonly ApplePay: "APPLE_PAY";
+    readonly GooglePay: "GOOGLE_PAY";
+    readonly SamsungPay: "SAMSUNG_PAY";
+    readonly RemoteCommercePrograms: "REMOTE_COMMERCE_PROGRAMS";
+};
+export type TokenWalletIdentifierEnum = typeof TokenWalletIdentifierEnum[keyof typeof TokenWalletIdentifierEnum];
+/**
+ *
+ * @export
+ * @interface Transaction
+ */
+export interface Transaction {
+    /**
+     * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved.  In case of scheme advices, this is generated and transmitted by the scheme.
+     * @type {string}
+     * @memberof Transaction
+     */
+    'authCode'?: string;
+    /**
+     * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
+     * @type {number}
+     * @memberof Transaction
+     */
+    'authValidity'?: number;
+    /**
+     * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
+     * @type {Money}
+     * @memberof Transaction
+     */
+    'billingAmount'?: Money;
+    /**
+     * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
+     * @type {Money}
+     * @memberof Transaction
+     */
+    'transactionAmount'?: Money;
+    /**
+     * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
+     * @type {Money}
+     * @memberof Transaction
+     */
+    'settlementAmount'?: Money;
+    /**
+     * Fee charged (for example, by the acquirer) for transaction activity.
+     * @type {Money}
+     * @memberof Transaction
+     */
+    'acquirerTransactionFeeAmount'?: Money;
+    /**
+     *
+     * @type {Array<TransactionFee>}
+     * @memberof Transaction
+     */
+    'issuerTransactionFees'?: Array<TransactionFee>;
+    /**
+     *
+     * @type {Array<CardholderVerificationMethod>}
+     * @memberof Transaction
+     */
+    'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
+    /**
+     * Merchant/acquirer generated transaction reference number.
+     * @type {string}
+     * @memberof Transaction
+     */
+    'retrievalReferenceNumber'?: string;
+    /**
+     *
+     * @type {CardEntryMode}
+     * @memberof Transaction
+     */
+    'cardEntryMode'?: CardEntryMode;
+    /**
+     * Indicates whether the cardholder is physically present during transaction.
+     * @type {boolean}
+     * @memberof Transaction
+     */
+    'cardholderPresent'?: boolean;
+    /**
+     * Indicates whether the card is present at the point of service.
+     * @type {boolean}
+     * @memberof Transaction
+     */
+    'cardPresent'?: boolean;
+    /**
+     * Indicates whether the transaction is a recurring payment or merchant initiated.  This implies whether the cardholder has approved the merchant initiated transaction.
+     * @type {boolean}
+     * @memberof Transaction
+     */
+    'merchantInitiated'?: boolean;
+    /**
+     * Date and time in the time zone where the transaction occurred.
+     * @type {string}
+     * @memberof Transaction
+     */
+    'transactionDateTime'?: string;
+    /**
+     * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
+     * @type {string}
+     * @memberof Transaction
+     */
+    'originalTransactionId'?: string;
+}
+/**
+ *
+ * @export
+ * @interface TransactionEvent
+ */
+export interface TransactionEvent {
+    /**
+     * Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
+     * @type {string}
+     * @memberof TransactionEvent
+     */
+    'id'?: string;
+    /**
+     * Unique ID assigned to VOID_AUTHORIZATION message category — applicable only for VOID_AUTHORIZATION.
+     * @type {string}
+     * @memberof TransactionEvent
+     */
+    'referenceTransactionEventId'?: string;
+    /**
+     * Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same `transactionId`.  For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same `transactionID`.
+     * @type {string}
+     * @memberof TransactionEvent
+     */
+    'transactionId'?: string;
+    /**
+     *
+     * @type {MessageCategoryTransactionEvent}
+     * @memberof TransactionEvent
+     */
+    'messageCategory'?: MessageCategoryTransactionEvent;
+    /**
+     *
+     * @type {MessageFunctionTransactionEvent}
+     * @memberof TransactionEvent
+     */
+    'messageFunction'?: MessageFunctionTransactionEvent;
+    /**
+     *
+     * @type {ClearingStatus}
+     * @memberof TransactionEvent
+     */
+    'clearingStatus'?: ClearingStatus;
+    /**
+     *
+     * @type {Card}
+     * @memberof TransactionEvent
+     */
+    'card'?: Card;
+    /**
+     *
+     * @type {Merchant}
+     * @memberof TransactionEvent
+     */
+    'merchant'?: Merchant;
+    /**
+     *
+     * @type {TransactionEventTransaction}
+     * @memberof TransactionEvent
+     */
+    'transaction'?: TransactionEventTransaction;
+    /**
+     *
+     * @type {Token}
+     * @memberof TransactionEvent
+     */
+    'token'?: Token;
+}
+/**
+ *
+ * @export
+ * @interface TransactionEventMetadata
+ */
+export interface TransactionEventMetadata {
+    /**
+     * Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.
+     * @type {string}
+     * @memberof TransactionEventMetadata
+     */
+    'id'?: string;
+    /**
+     * Unique ID assigned to VOID_AUTHORIZATION message category — applicable only for VOID_AUTHORIZATION.
+     * @type {string}
+     * @memberof TransactionEventMetadata
+     */
+    'referenceTransactionEventId'?: string;
+    /**
+     * Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same `transactionId`.  For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same `transactionID`.
+     * @type {string}
+     * @memberof TransactionEventMetadata
+     */
+    'transactionId'?: string;
+    /**
+     *
+     * @type {MessageCategoryTransactionEvent}
+     * @memberof TransactionEventMetadata
+     */
+    'messageCategory'?: MessageCategoryTransactionEvent;
+    /**
+     *
+     * @type {MessageFunctionTransactionEvent}
+     * @memberof TransactionEventMetadata
+     */
+    'messageFunction'?: MessageFunctionTransactionEvent;
+    /**
+     *
+     * @type {ClearingStatus}
+     * @memberof TransactionEventMetadata
+     */
+    'clearingStatus'?: ClearingStatus;
+}
+/**
+ *
+ * @export
+ * @interface TransactionEventTransaction
+ */
+export interface TransactionEventTransaction {
+    /**
+     * Enfuce generated code/number (6-digits)— returned to the merchant when authorisation is approved.  In case of scheme advices, this is generated and transmitted by the scheme.
+     * @type {string}
+     * @memberof TransactionEventTransaction
+     */
+    'authCode'?: string;
+    /**
+     * Number of days the authorisation is valid (applicable when merchants requests for extended authorisation period, longer than the default 7 days).
+     * @type {number}
+     * @memberof TransactionEventTransaction
+     */
+    'authValidity'?: number;
+    /**
+     * Transaction amount in the currency of the ledger account (associated with the card). If any issuer transaction fee is applied (see the issuerTransactionFees field), the billingAmount also includes those fees.
+     * @type {Money}
+     * @memberof TransactionEventTransaction
+     */
+    'billingAmount'?: Money;
+    /**
+     * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
+     * @type {Money}
+     * @memberof TransactionEventTransaction
+     */
+    'transactionAmount'?: Money;
+    /**
+     * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
+     * @type {Money}
+     * @memberof TransactionEventTransaction
+     */
+    'settlementAmount'?: Money;
+    /**
+     * Fee charged (for example, by the acquirer) for transaction activity.
+     * @type {Money}
+     * @memberof TransactionEventTransaction
+     */
+    'acquirerTransactionFeeAmount'?: Money;
+    /**
+     *
+     * @type {Array<TransactionFee>}
+     * @memberof TransactionEventTransaction
+     */
+    'issuerTransactionFees'?: Array<TransactionFee>;
+    /**
+     *
+     * @type {Array<CardholderVerificationMethod>}
+     * @memberof TransactionEventTransaction
+     */
+    'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
+    /**
+     * Merchant/acquirer generated transaction reference number.
+     * @type {string}
+     * @memberof TransactionEventTransaction
+     */
+    'retrievalReferenceNumber'?: string;
+    /**
+     *
+     * @type {CardEntryMode}
+     * @memberof TransactionEventTransaction
+     */
+    'cardEntryMode'?: CardEntryMode;
+    /**
+     * Indicates whether the cardholder is physically present during transaction.
+     * @type {boolean}
+     * @memberof TransactionEventTransaction
+     */
+    'cardholderPresent'?: boolean;
+    /**
+     * Indicates whether the card is present at the point of service.
+     * @type {boolean}
+     * @memberof TransactionEventTransaction
+     */
+    'cardPresent'?: boolean;
+    /**
+     * Indicates whether the transaction is a recurring payment or merchant initiated.  This implies whether the cardholder has approved the merchant initiated transaction.
+     * @type {boolean}
+     * @memberof TransactionEventTransaction
+     */
+    'merchantInitiated'?: boolean;
+    /**
+     * Date and time in the time zone where the transaction occurred.
+     * @type {string}
+     * @memberof TransactionEventTransaction
+     */
+    'transactionDateTime'?: string;
+    /**
+     * This value is present only for recurring transaction, and it\'s value is first original authorisation request in the chain.
+     * @type {string}
+     * @memberof TransactionEventTransaction
+     */
+    'originalTransactionId'?: string;
+    /**
+     *
+     * @type {TransactionTypeClearing}
+     * @memberof TransactionEventTransaction
+     */
+    'transactionType'?: TransactionTypeClearing;
+    /**
+     * Amount approved at the current payment processing stage; the amount might be further reduced in the subsequent stages, when the Ledger performs additional validations. If any issuer transaction fee is applied (see the issuerTransactionFees field), the approvedAmount also includes those fees.
+     * @type {Money}
+     * @memberof TransactionEventTransaction
+     */
+    'approvedAmount'?: Money;
+    /**
+     * Time when processed by Enfuce.
+     * @type {string}
+     * @memberof TransactionEventTransaction
+     */
+    'processedDateTime'?: string;
+    /**
+     * Contains previous amounts in a Financial message that has been corrected, in transaction currency.
+     * @type {Money}
+     * @memberof TransactionEventTransaction
+     */
+    'originalAmount'?: Money;
+    /**
+     * Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
+     * @type {string}
+     * @memberof TransactionEventTransaction
+     */
+    'reconciliationDate'?: string;
+    /**
+     * Identifies a reconciliation period in a reconciliation date.
+     * @type {string}
+     * @memberof TransactionEventTransaction
+     */
+    'reconciliationCycle'?: string;
+    /**
+     *
+     * @type {InterchangeFee}
+     * @memberof TransactionEventTransaction
+     */
+    'interchangeFee'?: InterchangeFee;
+    /**
+     *
+     * @type {ExchangeRates}
+     * @memberof TransactionEventTransaction
+     */
+    'exchangeRates'?: ExchangeRates;
+    /**
+     *
+     * @type {ClearingStatus}
+     * @memberof TransactionEventTransaction
+     */
+    'clearingStatus'?: ClearingStatus;
+    /**
+     * Indicates if transaction was cleared in a single operation.
+     * @type {boolean}
+     * @memberof TransactionEventTransaction
+     */
+    'partialClearingApplied'?: boolean;
+    /**
+     * Response to the authorisation. Indicates to the merchant if the authorisation was approved or declined. Supports alphanumeric codes (e.g., Visa N7).
+     * @type {string}
+     * @memberof TransactionEventTransaction
+     */
+    'responseCode'?: string;
+}
+/**
+ *
+ * @export
+ * @interface TransactionFee
+ */
+export interface TransactionFee {
+    /**
+     * Type of Issuer generated transaction fee in cardholder billing currency.  Transaction based fees that are additional fees charged on top of the transaction.
+     * @type {string}
+     * @memberof TransactionFee
+     */
+    'type'?: TransactionFeeTypeEnum;
+    /**
+     * Transaction fee amount in cardholder billing currency.
+     * @type {Money}
+     * @memberof TransactionFee
+     */
+    'amount'?: Money;
+}
+export declare const TransactionFeeTypeEnum: {
+    readonly CashFee: "CASH_FEE";
+    readonly AtmFee: "ATM_FEE";
+    readonly MarkupFee: "MARKUP_FEE";
+};
+export type TransactionFeeTypeEnum = typeof TransactionFeeTypeEnum[keyof typeof TransactionFeeTypeEnum];
+/**
+ * The transaction Type
+ * @export
+ * @enum {string}
+ */
+export declare const TransactionType: {
+    readonly Retail: "RETAIL";
+    readonly Atm: "ATM";
+    readonly Unique: "UNIQUE";
+    readonly CashDisbursement: "CASH_DISBURSEMENT";
+    readonly Credit: "CREDIT";
+    readonly OriginalCredit: "ORIGINAL_CREDIT";
+    readonly BalanceInquiry: "BALANCE_INQUIRY";
+    readonly P2PDebit: "P2P_DEBIT";
+    readonly P2PCredit: "P2P_CREDIT";
+    readonly PinChange: "PIN_CHANGE";
+    readonly PinUnblock: "PIN_UNBLOCK";
+    readonly Cashback: "CASHBACK";
+    readonly ConvenienceCheck: "CONVENIENCE_CHECK";
+    readonly BalanceTransfer: "BALANCE_TRANSFER";
+    readonly Reversal: "REVERSAL";
+    readonly Aft: "AFT";
+};
+export type TransactionType = typeof TransactionType[keyof typeof TransactionType];
+/**
+ * The transaction Type
+ * @export
+ * @enum {string}
+ */
+export declare const TransactionTypeClearing: {
+    readonly Retail: "RETAIL";
+    readonly Atm: "ATM";
+    readonly Unique: "UNIQUE";
+    readonly CashDisbursement: "CASH_DISBURSEMENT";
+    readonly Credit: "CREDIT";
+    readonly OriginalCredit: "ORIGINAL_CREDIT";
+    readonly BalanceInquiry: "BALANCE_INQUIRY";
+    readonly P2PDebit: "P2P_DEBIT";
+    readonly P2PCredit: "P2P_CREDIT";
+    readonly PinChange: "PIN_CHANGE";
+    readonly PinUnblock: "PIN_UNBLOCK";
+    readonly FeeCollectionDebit: "FEE_COLLECTION_DEBIT";
+    readonly FeeCollectionCredit: "FEE_COLLECTION_CREDIT";
+    readonly Cashback: "CASHBACK";
+    readonly ConvenienceCheck: "CONVENIENCE_CHECK";
+    readonly BalanceTransfer: "BALANCE_TRANSFER";
+    readonly Reversal: "REVERSAL";
+    readonly Aft: "AFT";
+};
+export type TransactionTypeClearing = typeof TransactionTypeClearing[keyof typeof TransactionTypeClearing];