@enfuce/nextgen-sdk 0.0.1

package/dist/esm/clearing-file-copy/api.d.ts

@@ -0,0 +1,1245 @@
+/**
+ * Enfuce clearing file copy
+ * 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.
+ */
+/**
+ * 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];
+/**
+ *
+ * @export
+ * @interface ClearingMetadata
+ */
+export interface ClearingMetadata {
+    /**
+     * 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 ClearingMetadata
+     */
+    'id'?: 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 ClearingMetadata
+     */
+    'transactionId'?: string;
+    /**
+     * Describes outcome of processed transaction
+     * @type {string}
+     * @memberof ClearingMetadata
+     */
+    'postingStatus'?: ClearingMetadataPostingStatusEnum;
+    /**
+     *
+     * @type {MessageCategoryClearing}
+     * @memberof ClearingMetadata
+     */
+    'messageCategory'?: MessageCategoryClearing;
+    /**
+     *
+     * @type {MessageFunctionClearing}
+     * @memberof ClearingMetadata
+     */
+    'messageFunction'?: MessageFunctionClearing;
+}
+export declare const ClearingMetadataPostingStatusEnum: {
+    readonly Processed: "PROCESSED";
+    readonly CardNotFound: "CARD_NOT_FOUND";
+    readonly Unsupported: "UNSUPPORTED";
+    readonly Metadata: "METADATA";
+};
+export type ClearingMetadataPostingStatusEnum = typeof ClearingMetadataPostingStatusEnum[keyof typeof ClearingMetadataPostingStatusEnum];
+/**
+ * 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;
+}
+/**
+ *
+ * @export
+ * @interface FileData
+ */
+export interface FileData {
+    /**
+     *
+     * @type {FileDataFileHeader}
+     * @memberof FileData
+     */
+    'fileHeader'?: FileDataFileHeader;
+    /**
+     * This array comprises a collection of records in the file.<br><br> Generally, the `transaction` object will be included. However, there are situations where the `masterCardMessage` object is present instead.<br><br> The `masterCardMessage` object is an unparsed ISO8583 message that has not been converted into a `transaction` object.<br><br> The `visaMessage` object represents a message in the Visa Base II format that has not been converted into a `transaction`, containing the mappings between the transaction component records (TCRs) and their data.
+     * @type {Array<FileDataRecordsInner>}
+     * @memberof FileData
+     */
+    'records'?: Array<FileDataRecordsInner>;
+}
+/**
+ * Header information of the file.
+ * @export
+ * @interface FileDataFileHeader
+ */
+export interface FileDataFileHeader {
+    /**
+     * This is the unique identifier for the file.
+     * @type {string}
+     * @memberof FileDataFileHeader
+     */
+    'fileId'?: string;
+    /**
+     * Name of the file as received from the scheme.
+     * @type {string}
+     * @memberof FileDataFileHeader
+     */
+    'fileName'?: string;
+    /**
+     * Date and time that Enfuce received the clearing file into the card system.
+     * @type {string}
+     * @memberof FileDataFileHeader
+     */
+    'fileReceivedDateTime'?: string;
+    /**
+     * The payment scheme of the file.
+     * @type {string}
+     * @memberof FileDataFileHeader
+     */
+    'paymentScheme'?: FileDataFileHeaderPaymentSchemeEnum;
+    /**
+     * Number of \'transactions\' objects in the file.
+     * @type {number}
+     * @memberof FileDataFileHeader
+     */
+    'numberOfTransactions'?: number;
+}
+export declare const FileDataFileHeaderPaymentSchemeEnum: {
+    readonly Mastercard: "MASTERCARD";
+    readonly Visa: "VISA";
+};
+export type FileDataFileHeaderPaymentSchemeEnum = typeof FileDataFileHeaderPaymentSchemeEnum[keyof typeof FileDataFileHeaderPaymentSchemeEnum];
+/**
+ *
+ * @export
+ * @interface FileDataRecordsInner
+ */
+export interface FileDataRecordsInner {
+    /**
+     * 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 FileDataRecordsInner
+     */
+    'id'?: 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 FileDataRecordsInner
+     */
+    'transactionId'?: string;
+    /**
+     * Describes outcome of processed transaction
+     * @type {string}
+     * @memberof FileDataRecordsInner
+     */
+    'postingStatus'?: FileDataRecordsInnerPostingStatusEnum;
+    /**
+     *
+     * @type {MessageCategoryClearing}
+     * @memberof FileDataRecordsInner
+     */
+    'messageCategory'?: MessageCategoryClearing;
+    /**
+     *
+     * @type {MessageFunctionClearing}
+     * @memberof FileDataRecordsInner
+     */
+    'messageFunction'?: MessageFunctionClearing;
+    /**
+     *
+     * @type {Card}
+     * @memberof FileDataRecordsInner
+     */
+    'card'?: Card;
+    /**
+     *
+     * @type {Merchant}
+     * @memberof FileDataRecordsInner
+     */
+    'merchant'?: Merchant;
+    /**
+     *
+     * @type {Transaction1}
+     * @memberof FileDataRecordsInner
+     */
+    'transaction'?: Transaction1;
+    /**
+     *
+     * @type {FileDataRecordsInnerAllOfMasterCardMessage}
+     * @memberof FileDataRecordsInner
+     */
+    'masterCardMessage'?: FileDataRecordsInnerAllOfMasterCardMessage;
+    /**
+     * The raw Visa message.
+     * @type {{ [key: string]: string; }}
+     * @memberof FileDataRecordsInner
+     */
+    'visaMessage'?: {
+        [key: string]: string;
+    } | null;
+}
+export declare const FileDataRecordsInnerPostingStatusEnum: {
+    readonly Processed: "PROCESSED";
+    readonly CardNotFound: "CARD_NOT_FOUND";
+    readonly Unsupported: "UNSUPPORTED";
+    readonly Metadata: "METADATA";
+};
+export type FileDataRecordsInnerPostingStatusEnum = typeof FileDataRecordsInnerPostingStatusEnum[keyof typeof FileDataRecordsInnerPostingStatusEnum];
+/**
+ *
+ * @export
+ * @interface FileDataRecordsInnerAllOfMasterCardMessage
+ */
+export interface FileDataRecordsInnerAllOfMasterCardMessage {
+    /**
+     * Message Type Identifier (MTI) n-4
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'MTI'?: string;
+    /**
+     * Processing code n-6
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE03'?: string;
+    /**
+     * Amount, Transaction n-12
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE04'?: string;
+    /**
+     * Amount, Reconciliation n-12
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE05'?: string;
+    /**
+     * Amount, Cardholder Billing n-12
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE06'?: string;
+    /**
+     * Conversion Rate, Reconciliation n-8
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE09'?: string;
+    /**
+     * Conversion Rate, Cardholder Billing n-8
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE10'?: string;
+    /**
+     * Date and Time, Local Transaction n-12; YYMMDDhhmmss
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE12'?: string;
+    /**
+     * Date, Expiration n-4; YYMM
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE14'?: string;
+    /**
+     * Point of Service (POS) Entry Mode an-12
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE22'?: string;
+    /**
+     * Card Sequence Number n-3
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE23'?: string;
+    /**
+     * Function Code n-3
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE24'?: string;
+    /**
+     * Point of Service Condition Code n-4
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE25'?: string;
+    /**
+     * Point of Service PIN capture Code n-4
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE26'?: string;
+    /**
+     * Amounts, Original n-24
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE30'?: string;
+    /**
+     * Acquirer Reference Data n-23; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE31'?: string;
+    /**
+     * Acquiring institution Identification Code n...11; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE32'?: string;
+    /**
+     * Forwarding institution Identification Code n...11; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE33'?: string;
+    /**
+     * Retrieval Reference Number ans-12
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE37'?: string;
+    /**
+     * Approval Code ans-6
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE38'?: string;
+    /**
+     * Service Code n-3
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE40'?: string;
+    /**
+     * Card Acceptor Terminal ID ans-8
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE41'?: string;
+    /**
+     * Card Acceptor ID Code ans-15
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE42'?: string;
+    /**
+     * Card Acceptor Name/Location ans...99; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE43'?: string;
+    /**
+     * Additional Data an...999; LLLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE48'?: string;
+    /**
+     * Currency Code, Transaction n-3
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE49'?: string;
+    /**
+     * Currency Code, Reconciliation n-3
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE50'?: string;
+    /**
+     * Currency Code, Cardholder Billing n-3
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE51'?: string;
+    /**
+     * Amounts, Additional ans-20; LLLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE54'?: string;
+    /**
+     * Additional Data 2 ans...999; LLLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE62'?: string;
+    /**
+     * Transaction Life Cycle ID ans-16; LLLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE63'?: string;
+    /**
+     * Message Number n-8
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE71'?: string;
+    /**
+     * Data Record ans...999; LLLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE72'?: string;
+    /**
+     * Date, Action n-6; YYMMDD
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE73'?: string;
+    /**
+     * Transaction Destination Institution ID Code n...11; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE93'?: string;
+    /**
+     * Transaction Originator Institution ID Code n...11; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE94'?: string;
+    /**
+     * Card Issuer Reference Data n-10; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE95'?: string;
+    /**
+     * Receiving Institution ID Code n...11; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE100'?: string;
+    /**
+     * Multi-Use Transaction Identification Data ans...999; LLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE105'?: string;
+    /**
+     * Amount, Currency Conversion Assessment
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE111'?: string;
+    /**
+     * Additional Data 3 ans...999; LLLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE123'?: string;
+    /**
+     * Additional Data 4 ans...999; LLLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE124'?: string;
+    /**
+     * Additional Data 5 ans...999; LLLVAR
+     * @type {string}
+     * @memberof FileDataRecordsInnerAllOfMasterCardMessage
+     */
+    'DE125'?: string;
+}
+/**
+ * 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;
+}
+/**
+ * Metadata relevant to the clearing file copy. <Note>As per the current implementation, we are using the `FINANCIAL` message category only.</Note>
+ * @export
+ * @enum {string}
+ */
+export declare const MessageCategoryClearing: {
+    readonly Financial: "FINANCIAL";
+    readonly FinancialAddendum: "FINANCIAL_ADDENDUM";
+    readonly FeeCollection: "FEE_COLLECTION";
+    readonly Reconciliation: "RECONCILIATION";
+    readonly DocumentRequest: "DOCUMENT_REQUEST";
+    readonly Chargeback: "CHARGEBACK";
+    readonly ChargebackReversal: "CHARGEBACK_REVERSAL";
+    readonly Representment: "REPRESENTMENT";
+    readonly RepresentmentReversal: "REPRESENTMENT_REVERSAL";
+};
+export type MessageCategoryClearing = typeof MessageCategoryClearing[keyof typeof MessageCategoryClearing];
+/**
+ * Identifies the message function of the clearing message.
+ * @export
+ * @enum {string}
+ */
+export declare const MessageFunctionClearing: {
+    readonly Notification: "NOTIFICATION";
+};
+export type MessageFunctionClearing = typeof MessageFunctionClearing[keyof typeof MessageFunctionClearing];
+/**
+ * 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;
+}
+/**
+ *
+ * @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 Transaction1
+ */
+export interface Transaction1 {
+    /**
+     * 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 Transaction1
+     */
+    '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 Transaction1
+     */
+    '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 Transaction1
+     */
+    'billingAmount'?: Money;
+    /**
+     * The transaction amount in the local currency of the acquirer or the merchant, where the transaction occurred.
+     * @type {Money}
+     * @memberof Transaction1
+     */
+    'transactionAmount'?: Money;
+    /**
+     * The amount of funds transferred between the acquirer and the issuer, equal to the `transactionAmount`, in the settlement currency.
+     * @type {Money}
+     * @memberof Transaction1
+     */
+    'settlementAmount'?: Money;
+    /**
+     * Fee charged (for example, by the acquirer) for transaction activity.
+     * @type {Money}
+     * @memberof Transaction1
+     */
+    'acquirerTransactionFeeAmount'?: Money;
+    /**
+     *
+     * @type {Array<TransactionFee>}
+     * @memberof Transaction1
+     */
+    'issuerTransactionFees'?: Array<TransactionFee>;
+    /**
+     *
+     * @type {Array<CardholderVerificationMethod>}
+     * @memberof Transaction1
+     */
+    'cardholderVerificationMethods'?: Array<CardholderVerificationMethod>;
+    /**
+     * Merchant/acquirer generated transaction reference number.
+     * @type {string}
+     * @memberof Transaction1
+     */
+    'retrievalReferenceNumber'?: string;
+    /**
+     *
+     * @type {CardEntryMode}
+     * @memberof Transaction1
+     */
+    'cardEntryMode'?: CardEntryMode;
+    /**
+     * Indicates whether the cardholder is physically present during transaction.
+     * @type {boolean}
+     * @memberof Transaction1
+     */
+    'cardholderPresent'?: boolean;
+    /**
+     * Indicates whether the card is present at the point of service.
+     * @type {boolean}
+     * @memberof Transaction1
+     */
+    '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 Transaction1
+     */
+    'merchantInitiated'?: boolean;
+    /**
+     * Date and time in the time zone where the transaction occurred.
+     * @type {string}
+     * @memberof Transaction1
+     */
+    '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 Transaction1
+     */
+    'originalTransactionId'?: string;
+    /**
+     *
+     * @type {TransactionTypeClearing}
+     * @memberof Transaction1
+     */
+    'transactionType'?: TransactionTypeClearing;
+    /**
+     * Contains previous amounts in a Financial message that has been corrected, in transaction currency.
+     * @type {Money}
+     * @memberof Transaction1
+     */
+    'originalAmount'?: Money;
+    /**
+     * Identifies the clearing systems processing date expressed in the local time zone of the clearing system.
+     * @type {string}
+     * @memberof Transaction1
+     */
+    'reconciliationDate'?: string;
+    /**
+     * Identifies a reconciliation period in a reconciliation date.
+     * @type {string}
+     * @memberof Transaction1
+     */
+    'reconciliationCycle'?: string;
+    /**
+     * Time when processed by Enfuce.
+     * @type {string}
+     * @memberof Transaction1
+     */
+    'processedDateTime'?: string;
+    /**
+     *
+     * @type {InterchangeFee}
+     * @memberof Transaction1
+     */
+    'interchangeFee'?: InterchangeFee;
+    /**
+     *
+     * @type {ExchangeRates}
+     * @memberof Transaction1
+     */
+    'exchangeRates'?: ExchangeRates;
+    /**
+     * The amount (in ch billing currency) that the authorisation should be adjusted to in case a merchant makes an adjustment.
+     * @type {Money}
+     * @memberof Transaction1
+     */
+    'replacementAmount'?: Money;
+    /**
+     * The cashback amount received at clearing time.
+     * @type {Money}
+     * @memberof Transaction1
+     */
+    'cashbackAmount'?: Money;
+    /**
+     *
+     * @type {ClearingStatus}
+     * @memberof Transaction1
+     */
+    'clearingStatus'?: ClearingStatus;
+    /**
+     * Indicates if transaction was cleared in a single operation.
+     * @type {boolean}
+     * @memberof Transaction1
+     */
+    'partialClearingApplied'?: boolean;
+    /**
+     * Time of the authorization request.
+     * @type {string}
+     * @memberof Transaction1
+     */
+    'authorizationProcessedDateTime'?: 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 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];