--- title: "Get all payments" method: GET path: "/v3/merchants/{mId}/payments" tags: ["PAYMENTS"] --- # Get all payments `GET /v3/merchants/{mId}/payments` Retrieves payment information, including the total amount, tip amount, tax amount, and result status. ## Path parameters - `mId` string, required ## Query parameters - `filter` string - `expand` string ## Headers - `User-Agent` string, required ## Response `200` Successful response. Displays all payment information. - object - `id` string — Unique identifier of the merchant. Length: 13 digits - `order` object — Order with which the payment is associated. - `id` string — Unique identifier of the order. - `device` object — Device that processed the transaction for this payment. - `id` string — Universally unique identifier (UUID) of the device that processed the payment transaction. This is different from the 13-digit Clover-assigned identifier of the device. - `tender` object — Tender type associated with this payment, for example, credit card, cash, and so on. - `id` string — Unique identifier of the tender. - `editable` boolean — Indicates if the merchant tender type is editable. - `labelKey` string — Label key. - `label` string — Label name. - `opensCashDrawer` boolean — Indicates whether the cash drawer can be opened. - `supportsTipping` boolean — Indicates whether tipping on payment is allowed using the tender. - `enabled` boolean — Indicates whether merchant tender is enabled. - `visible` boolean — Indicates that merchant tender is visible. - `instructions` string — Instructions for the refund. - `amount` integer — Total amount paid. - `tipAmount` integer — Amount paid in tips. - `taxAmount` integer — Amount paid in tax. - `cashbackAmount` integer — Amount returned in a cashback transaction. - `cashTendered` integer — Amount paid by the customer in cash. - `externalPaymentId` string — Point of sale (POS)-assigned unique identifier for the transaction. Critical for reconciliation and recovery. - `employee` object — Details of employee who processed the payment. - `id` string — Unique identifier of the employee. - `createdTime` integer — Time when the payment was recorded on the server. - `clientCreatedTime` integer — Time when the payment was saved on the client. - `gatewayProcessingTime` integer — Time when the payment gateway processed the payment. - `modifiedTime` integer — Time when the payment was modified. - `offline` boolean — Indicates whether the payment was accepted offline. - `result` 'SUCCESS' | 'FAIL' | 'INITIATED' | 'VOIDED' | 'VOIDING' | 'VOID_FAILED' | 'AUTH' | 'AUTH_COMPLETED' | 'DISCOUNT' | 'OFFLINE_RETRYING' | 'PENDING' — Result of the payment transaction, for example: initiated, success, fail, voided, and so on. - `cardTransaction` object — Information about the card used for credit or debit card refunds. - `cardType` 'VISA' | 'MC' | 'AMEX' | 'DISCOVER' | 'DINERS_CLUB' | 'JCB' | 'MAESTRO' | 'SOLO' | 'LASER' | 'CHINA_UNION_PAY' | 'CARTE_BLANCHE' | 'UNKNOWN' | 'GIFT_CARD' | 'EBT' | 'GIROCARD' | 'INTERAC' | 'OTHER' | 'RUPAY' — Type of card, for example: Mastercard, Visa, Discover, Interac, and so on. - `entryType` 'SWIPED' | 'KEYED' | 'VOICE' | 'VAULTED' | 'OFFLINE_SWIPED' | 'OFFLINE_KEYED' | 'EMV_CONTACT' | 'EMV_CONTACTLESS' | 'MSD_CONTACTLESS' | 'PINPAD_MANUAL_ENTRY' | 'QR_CODE' | 'SCANNED' — Card entry method for a payment transaction, for example: Swiped, Keyed, EMV_Contact, EMV_Contactless, and so on. - `first6` string — First 6 digits of the card number. - `last4` string — Last 4 digits of the card number. - `type` 'AUTH' | 'PREAUTH' | 'PREAUTHCAPTURE' | 'ADJUST' | 'VOID' | 'VOIDRETURN' | 'RETURN' | 'REFUND' | 'NAKEDREFUND' | 'GETBALANCE' | 'BATCHCLOSE' | 'ACTIVATE' | 'BALANCE_LOCK' | 'LOAD' | 'CASHOUT' | 'CASHOUT_ACTIVE_STATUS' | 'REDEMPTION' | 'REDEMPTION_UNLOCK' | 'RELOAD' | 'CASH_ADVANCE' | 'VOID_CREDIT' | 'REFUND_CREDIT' | 'INTERNET_ACTIVATE' | 'TOKEN_REQUEST' | 'VERIFICATION' — Type of transaction, for example: Auth, PreAuth, Cash_Advance, Refund-Credit. - `authCode` string — Authorization code, if the transaction is successful. - `referenceId` string — Unique identifier of the transaction. - `transactionNo` string — Transaction number. - `state` 'PENDING' | 'CLOSED' — Transaction status. Indicates whether the payment gateway captured the transaction. Values: Pending Closed - `extra` object — Extra information stored as part of payment gateway or card transaction. - `default` string — Indicates any default message to display. - `begBalance` integer — Beginning balance at the time of the transaction. - `endBalance` integer — Ending balance at the time of the transaction. - `avsResult` 'SUCCESS' | 'ZIP_CODE_MATCH' | 'ZIP_CODE_MATCH_ADDRESS_NOT_CHECKED' | 'ADDRESS_MATCH' | 'ADDRESS_MATCH_ZIP_NOT_CHECKED' | 'NEITHER_MATCH' | 'SERVICE_FAILURE' | 'SERVICE_UNAVAILABLE' | 'NOT_CHECKED' | 'ZIP_CODE_NOT_MATCHED_ADDRESS_NOT_CHECKED' | 'ADDRESS_NOT_MATCHED_ZIP_CODE_NOT_CHECKED' — Result of address verification service (AVS). AVS is a service provided by credit card processors and issuing banks to verify that the address entered by the customer is associated with the cardholder's credit card account. AVS check is a part of the merchant's request for authorization in a card-not-present (CNP) transaction. Values: Success, Zip_Code_Match, Address_Not_Checked, and so on. - `cardholderName` string — Cardholder name. - `token` string — Card token. - `vaultedCard` object — Indicates a vaulted card that can be used for subsequent transactions. Credit card vaulting securely stores credit card information, allowing charges to be made without the need to re-enter the card details. - `first6` string, required — First 6 digits of the vaulted card number. - `last4` string, required — Last 4 digits of the vaulted card number. - `cardholderName` string — Cardholder name of the vaulted card. - `expirationDate` string — Expiration date of the vaulted card. - `token` string — Vaulted card token. - `gatewayTxState` 'INITIATED' | 'INITIATED_ON_AUTH' | 'ACKNOWLEDGED' | 'CONNECT_FAILED' | 'TIMEOUT' | 'FAILED' | 'REVERSE_INITIATED' | 'REVERSE_INITIATED_ON_AUTH' | 'REVERSED' | 'REVERSAL_FAILED' | 'EXTERNAL' — Current status of payment gateway transaction. This field differs from the legacy 'state' field that is calculated from the 'type' field and indicates whether the transaction was captured. Values: Initiated, Acknowledged, Timeout, Failed, and so on. - `currency` string — Three-letter [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). - `captured` boolean — Indicates whether the gateway captured the transaction. Values: True False - `debitRefund` object — Refund parameters required for debit card refunds. - `debitTransactionRouteInd` string — Indicates the debit card transaction routing. In the U.S., merchants accepting cards have the option to select the specific network on the card for each transaction. The process of choosing a network for a transaction is known as debit routing. - `isDebitTransactionRefundable` boolean — Indicates whether the debit transaction is refundable. Values: True, if debitTransactionRouteInd is `C`, else it's determined by the Electronic Debit System (EDS) or debit entitlement rule for D/S. False - `serviceCharge` object — Amount recorded as a service charge. - `id` string — Unique identifier of the service charge. - `name` string — Service change name. - `amount` integer — Service charge amount. - `attributes` object - `default` string — Information related to attributes. - `additionalCharges` object[] — List of additional charges. - `id` string — Unique identifier of the additional charge. - `amount` integer — Additional charge amount. - `rate` integer — Percent rate of the additional charge times 10000. - `type` 'INTERAC' | 'CREDIT_SURCHARGE' | 'CONVENIENCE_FEE' | 'INTERAC_V2' | 'DELIVERY_FEE' — Additional charge type. - `taxRates` object[] - `id` string — Tax rate identifier. - `name` string, required — Tax rate name. - `rate` integer, required — Tax rate. Format: 100% = 1e7 or 1 followed by 7 zeros. - `isDefault` boolean — Indicates whether the tax rate was configured as a default tax rate when the payment was created. - `taxableAmount` integer, required — Sub-total of line items on which the tax was based. For value-added tax (VAT), this amount includes the tax. For all others, this amount does not include tax. - `isVat` boolean — Indicates if the taxable amount includes value-added tax (VAT). - `taxAmount` integer — Amount of tax collected. In cases of multiple payments for an order, it may be necessary to add an extra cent of tax to the last payment. - `refunds` object[] — Amount to refund. - `id` string — Unique identifier of the refund. - `orderRef` object — Reference number of the order with which the refund is associated. - `id` string — Unique identifier of the order associated with the refund. - `device` object — Device that processed the transaction. - `id` string — Universally unique identifier (UUID) of the device that processed the transaction for therefund. Format: 128-bit; this is different from the base-13 Clover ID of the device. - `amount` integer — Total amount refunded, including tax and tip. - `taxAmount` integer — Tax amount refunded. - `tipAmount` integer — Tip amount refunded. - `createdTime` integer — Time when the refund was saved on the server. - `clientCreatedTime` integer — Time when the refund was saved on the client. - `gatewayProcessingTime` integer — Time when the payment gateway processed the refund. - `payment` object — Payment with which the refund is associated. - `id` string — Unique identifier of the payment. - `employee` object — Details of employee who processed the refund. - `id` string — Unique identifier of the employee. - `lineItems` object[] - `id` string — Unique identifier of the lineitem. - `overrideMerchantTender` object — Tender type associated with this payment, for example, credit card, cash, and so on. - `id` string — Unique identifier of the tender. - `editable` boolean — Indicates if the merchant tender type is editable. Values: True False - `labelKey` string — Label key. - `label` string — Label name. - `opensCashDrawer` boolean — Indicates whether the cash drawer can be opened. - `supportsTipping` boolean — Indicates whether tipping on payment is allowed using the tender. - `enabled` boolean — Indicates whether merchant tender is enabled. - `visible` boolean — Indicates that merchant tender is visible. - `instructions` string — Instructions for the refund. - `taxableAmountRates` object[] — Details of the taxable amount rates. - `id` string — Tax rate identifier. - `name` string — Optional. Tax rate name. - `taxableAmount` integer — Sub-total of line items on which the tax was based. For value-added tax (VAT), this amount includes the tax. For all others, this amount does not include tax. - `rate` integer — Tax rate. Format: 100% = 1e7 or 1 followed by 7 zeros. - `isVat` boolean — Indicates if the taxable amount includes value-added tax (VAT). - `taxAmount` integer — Tax amount collected. In cases of multiple payments for an order, it may be necessary to add an extra cent of tax to the last payment. - `transactionRef` object — Refund with which the tax rate is associated. - `id` string — Unique identifier of the transaction. - `serviceChargeAmount` object — Information related to the service charge. - `id` string — Unique identifier of the service charge. - `name` string — Service change name. - `amount` integer — Service charge amount. - `additionalCharges` object[] — List of additional charges. - `id` string — Unique identifier of the additional charge. - `amount` integer — Additional charge amount. - `rate` integer — Percent rate of the additional charge times 10000. - `type` 'INTERAC' | 'CREDIT_SURCHARGE' | 'CONVENIENCE_FEE' | 'INTERAC_V2' | 'DELIVERY_FEE' — Additional charge type. - `attributes` object — Information related to attributes. - `default` string — Default value of attributes. - `germanInfo` object — Default value of attributes. - `cardTrack2` string - `cardSequenceNumber` string - `transactionCaseGermany` string - `transactionTypeGermany` string - `terminalID` string - `traceNumber` string - `oldTraceNumber` string - `receiptNumber` string - `transactionAID` string - `transactionMSApp` string - `transactionScriptResults` string - `receiptType` string - `customerTransactionDOLValues` string - `merchantTransactionDOLValues` string - `merchantJournalDOL` string - `merchantJournalDOLValues` string - `configMerchantId` string - `configProductLabel` string - `hostResponseAidParBMP53` string - `hostResponsePrintDataBM60` string - `sepaElvReceiptFormat` string - `sepaElvExtAppLabel` string - `sepaElvPreNotification` string - `sepaElvMandate` string - `sepaElvCreditorId` string - `sepaElvMandateId` string - `sepaElvIban` string - `appTracking` object — Tracking information for the app that created this refund. - `developerAppId` string — Universally unique identifier (UUID) of the developer app. Populated and used only in the back end system. - `applicationName` string — Developer application name. - `applicationID` string — Unique identifier (ID) of the application. - `applicationVersion` string — Semantic version of the application, such as Major, Minor, or Patch. See http://semver.org/ - `sourceSDK` string — Source software development kit (SDK). - `sourceSDKVersion` string — Semantic version of the source SDK. See http://semver.org/ - `voided` boolean — Indicates whether transaction was voided. - `voidReason` string — Reason to void the transaction. - `cardTransaction` object — Information about the card used for credit or debit card refunds. - `cardType` 'VISA' | 'MC' | 'AMEX' | 'DISCOVER' | 'DINERS_CLUB' | 'JCB' | 'MAESTRO' | 'SOLO' | 'LASER' | 'CHINA_UNION_PAY' | 'CARTE_BLANCHE' | 'UNKNOWN' | 'GIFT_CARD' | 'EBT' | 'GIROCARD' | 'INTERAC' | 'OTHER' | 'RUPAY' — Type of card, for example: Mastercard, Visa, Discover, Interac, and so on. - `entryType` 'SWIPED' | 'KEYED' | 'VOICE' | 'VAULTED' | 'OFFLINE_SWIPED' | 'OFFLINE_KEYED' | 'EMV_CONTACT' | 'EMV_CONTACTLESS' | 'MSD_CONTACTLESS' | 'PINPAD_MANUAL_ENTRY' | 'QR_CODE' | 'SCANNED' — Card entry method for a payment transaction, for example: Swiped, Keyed, EMV_Contact, EMV_Contactless, and so on. - `first6` string — First 6 digits of the card number. - `last4` string — Last 4 digits of the card number. - `type` 'AUTH' | 'PREAUTH' | 'PREAUTHCAPTURE' | 'ADJUST' | 'VOID' | 'VOIDRETURN' | 'RETURN' | 'REFUND' | 'NAKEDREFUND' | 'GETBALANCE' | 'BATCHCLOSE' | 'ACTIVATE' | 'BALANCE_LOCK' | 'LOAD' | 'CASHOUT' | 'CASHOUT_ACTIVE_STATUS' | 'REDEMPTION' | 'REDEMPTION_UNLOCK' | 'RELOAD' | 'CASH_ADVANCE' | 'VOID_CREDIT' | 'REFUND_CREDIT' | 'INTERNET_ACTIVATE' | 'TOKEN_REQUEST' | 'VERIFICATION' — Type of transaction, for example: Auth, PreAuth, Cash_Advance, Refund-Credit. - `authCode` string — Authorization code, if transaction is successful. - `referenceId` string — Unique identifier of the transaction. - `transactionNo` string — Transaction number. - `state` 'PENDING' | 'CLOSED' — Transaction status. Indicates whether the payment gateway captured the transaction. Values: Closed Pending - `extra` object — Extra information stored as part of payment gateway or card transaction. - `default` string — Default message to display. - `begBalance` integer — Beginning balance at the time of the transaction. - `endBalance` integer — Beginning balance at the time of the transaction. - `avsResult` 'SUCCESS' | 'ZIP_CODE_MATCH' | 'ZIP_CODE_MATCH_ADDRESS_NOT_CHECKED' | 'ADDRESS_MATCH' | 'ADDRESS_MATCH_ZIP_NOT_CHECKED' | 'NEITHER_MATCH' | 'SERVICE_FAILURE' | 'SERVICE_UNAVAILABLE' | 'NOT_CHECKED' | 'ZIP_CODE_NOT_MATCHED_ADDRESS_NOT_CHECKED' | 'ADDRESS_NOT_MATCHED_ZIP_CODE_NOT_CHECKED' — Result of address verification service (AVS). AVS is a service provided by credit card processors and issuing banks to verify that the address entered by the customer is associated with the cardholder's credit card account. AVS check is a part of the merchant's request for authorization in a card-not-present (CNP) transaction. Values: Success, Zip_Code_Match, Address_Not_Checked, and so on. - `cardholderName` string — Cardholder name. - `token` string — Card token. - `vaultedCard` object — Indicates a vaulted card that can be used for subsequent transactions. Credit card vaulting securely stores credit card information, allowing charges to be made without the need to re-enter the card details. - `first6` string, required — First 6 digits of the vaulted card number. - `last4` string, required — Last 4 digits of the vaulted card number. - `cardholderName` string — Cardholder name of the vaulted card. - `expirationDate` string — Expiration date of the vaulted card. - `token` string — Vaulted card token. - `gatewayTxState` 'INITIATED' | 'INITIATED_ON_AUTH' | 'ACKNOWLEDGED' | 'CONNECT_FAILED' | 'TIMEOUT' | 'FAILED' | 'REVERSE_INITIATED' | 'REVERSE_INITIATED_ON_AUTH' | 'REVERSED' | 'REVERSAL_FAILED' | 'EXTERNAL' — Current status of payment gateway transaction. This field differs from the legacy 'state' field that is calculated from the 'type' field and indicates whether the transaction was captured. Values: Initiated, Acknowledged, Timeout, Failed, and so on. - `currency` string — Three-letter [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). - `captured` boolean — Indicates whether the gateway captured the transaction. Values: True False - `debitRefund` object — Refund parameters required for debit card refunds. - `debitTransactionRouteInd` string — Route of the payment transaction. - `isDebitTransactionRefundable` boolean — Indicates whether the debit transaction is refundable. Values: True, if debitTransactionRouteInd is C, else it's determined by the Electronic Debit System (EDS) or debit entitlement rule for D/S. False - `transactionInfo` object — Transaction information. - `languageIndicator` string — Indicates language used for the transaction. Deprecated; Use transactionLocale. - `transactionLocale` string — Locale for the transaction, for example: en-CA. - `accountSelection` 'CREDIT' | 'DEBIT' | 'CHECKING' | 'SAVINGS' — Type of account. Values: Credit Debit Checking Savings - `fiscalInvoiceNumber` string — Invoice number. Format: 4-digits prefix + 8 digits. - `installmentsQuantity` integer — Number of installments. - `installmentsPlanCode` string — Indicates plan in the Alphanumeric code of the installment plan. - `installmentsPlanId` string — Identifier of the selected installment plan. - `installmentsPlanDesc` string — Description of the selected installment plan. - `cardTypeLabel` string — Card type label. - `cardSymbol` string — Card symbol to identify in payment_card_config table. - `stan` integer — System audit trace number (STAN). - `identityDocument` object — Customer identification number and type. - `id` string — Identity unique identifier. - `type` string — Type of personal identification. Example: National Document, Passport, etc - `number` string — Identification number. - `createdTime` integer — Time when identification was created. - `modifiedTime` integer — Time when identification was modified. - `deletedTime` integer — Time when identification was deleted. - `payment` object - `id` string — Payment unique identifier. - `batchNumber` string — Transaction batch number. - `receiptNumber` string — Transaction receipt number. - `reversalStanRefNum` string — Reversal system audit trace number (STAN). - `reversalStan` integer — STAN for reversal. - `reversalMac` string — MAC for reversal. Message authentication code (MAC) is a short code used to allow the receiver of a message to authenticate the message is from a trusted sender. - `reversalMacKsn` string — MAC Key Serial Number (KSN) for reversal. KSN is part of the calculation of the MAC key, which is unique per usage. - `terminalIdentification` string — Unique location of a terminal at a merchant. - `externalTerminalId` string — Main internal identifier of a terminal which should be the same across all Fiserv’ components. - `merchantIdentifier` string — Identifier which is concatenated with the Acquirer Identifier to uniquely identify a given merchant. - `merchantNameLocation` string — Name and location of the merchant. - `maskedTrack2` string — Masked track2 data from the magnetic stripe of the card. - `receiptExtraData` string — Extra data for the receipt. - `selectedService` 'NONE' | 'PAYMENT' | 'REFUND' | 'CANCELLATION' | 'PRE_AUTH' | 'UPDATE_PRE_AUTH' | 'PAYMENT_COMPLETION' | 'CASH_ADVANCE' | 'DEFERRED_PAYMENT' | 'DEFERRED_PAYMENT_COMPLETION' | 'VOICE_AUTHORISATION' | 'CARDHOLDER_DETECTION' | 'TOKEN_REQUEST' | 'VERIFICATION' — Financial service selected for the transaction. - `transactionResult` 'APPROVED' | 'DECLINED' | 'ABORTED' | 'VOICE_AUTHORISATION' | 'PAYMENT_PART_ONLY' | 'PARTIALLY_APPROVED' | 'NONE' — Result of the transaction. - `transactionTags` string — Includes a hex string with `Tag + Length + Value (TLV)` tags for certification. - `txFormat` 'DEFAULT' | 'NEXO' — Information on how to code the data inside transaction Tags. Format: Default and NEXO protocols - `panMask` string — Information on how to mask the card primary account number (PAN). - `transactionSequenceCounter` string — Counter maintained by the terminal that is incremented for each transaction at the beginning of the Perform service function. - `applicationPanSequenceNumber` string — Identifies and differentiates cards with the same primary account number (PAN). - `reversalReason` 'CHIP_DECLINE' | 'CARDHOLDER_CANCELLATION' | 'COMMUNICATION_ERROR' | 'OTHER_REASON' — Reason to reverse the transaction d on the host. It has to be mapped on the server with the expected value by the corresponding gateway. - `isTokenBasedTx` boolean — Indicates whether the transaction is token based, using a vaulted card. - `origTransactionSequenceCounter` string — For reversal and capture transactions, this includes the reference (transactionSequenceCounter) to the originating transaction. - `transactionSequenceCounterUpdate` string — Displays information when the transaction sequence counter (TSC) of a terminal is out of sync and is provided with an update. - `emergencyFlag` boolean — Indicates whether the corresponding transaction was performed in NEXO emergency mode according to the [nexo ISO specifications](https://www.nexo-standards.org/standards). - `entryType` 'SWIPED' | 'KEYED' | 'VOICE' | 'VAULTED' | 'OFFLINE_SWIPED' | 'OFFLINE_KEYED' | 'EMV_CONTACT' | 'EMV_CONTACTLESS' | 'MSD_CONTACTLESS' | 'PINPAD_MANUAL_ENTRY' | 'QR_CODE' | 'SCANNED' — Card entry method. Indicates the card entry type to make a payment. Example: swiped, vaulted, scanned, and so on. - `promotionalMessage` object - `message` string — Promotional message. - `showOnMerchantReceipt` boolean — Indicates whether a message should display on the merchant receipt. Value: True False. - `showOnCustomerReceipt` boolean — Indicates whether a message should display on the customer receipt. Value: True False. - `showOnDisplay` boolean — Indicates whether a message should display on the screen or not. Value: True False. - `sepaElvTransactionInfo` object — Provides information related to SEPA ELV transactions. [Single Euro Payments Area (SEPA)](https://www.hba.gr/UplFiles/sepa/SEPA%20Guidance%20final.PDF) is a European Union (EU) payments integration initiative. ELV (German) indicates the end of transition period for payment transactions generated using a payment card at the point of sale. - `receiptFormat` string — Value of tag E1.DF8206 from NEXO config. - `extAppLabel` string — Value of tag E6.DF8211 or E6.DF8212 (Online or Offline TX printout). - `preNotification` string — Value of tag E6.DF8214 info from the NEXO config. - `mandate` string — Value of tag E6.DF8215 info from NEXO config. - `creditorId` string — Value of tag E6.DF8216 info from NEXO config. - `mandateId` string — Mandate identifier generated by SPA according to ELV – TBD: use Trace number instead of receipt number. - `iban` string — International Bank Account Number `(IBAN)`. Uniquely identifies the account of a customer at a financial institution as defined in ISO 13616. Received in Integrated Circuit Card (ICC) related data from IPG (tag 5F53). - `isMerchantForced` boolean — Indicates if the corresponding SEPA ELV TX transaction was forced by the merchant (override defined limit). See sepaElvTransactionInfo. - `clientCardType` 'VISA' | 'MC' | 'AMEX' | 'DISCOVER' | 'DINERS_CLUB' | 'JCB' | 'MAESTRO' | 'SOLO' | 'LASER' | 'CHINA_UNION_PAY' | 'CARTE_BLANCHE' | 'UNKNOWN' | 'GIFT_CARD' | 'EBT' | 'GIROCARD' | 'INTERAC' | 'OTHER' | 'RUPAY' — Client card type. Read-only field that is used only for limited purpose and must not be overwritten on server or client once set up on the client. This is not the same as cardType in other objects. The client card type is set up on the client only for magnetic stripe reader transactions (MSR tx) for now as the application identifier (AID) is not identified for MSR. For a few MSR tx, the card type is identified incorrectly on client side, and also on server side based on the bank identification number (BIN) match.To Get the correct card types, this client card type is sent to the server. - `explicitlySelectedApp` string — App that the customer selects using a choice button. - `isSepaElv` boolean — Indicates whether the corresponding transaction was performed as SEPA ELV TX. See sepaElvTransactionInfo. - `cardEntryType` 'SWIPED' | 'KEYED' | 'VOICE' | 'VAULTED' | 'OFFLINE_SWIPED' | 'OFFLINE_KEYED' | 'EMV_CONTACT' | 'EMV_CONTACTLESS' | 'MSD_CONTACTLESS' | 'PINPAD_MANUAL_ENTRY' | 'QR_CODE' | 'SCANNED' — Card entry method used for the SEPA ELV TX transaction. - `printMessages` object[] - `destination` 'CUSTOMER_DISPLAY' | 'CUSTOMER_RECEIPT' | 'CUSTOMER_RECEIPT_AID_PARAM' | 'MERCHANT_DISPLAY' | 'MERCHANT_RECEIPT' | 'MERCHANT_RECEIPT_AID_PARAM' — Indicates where to display the message: CDSP - CustomerDisplay CRCP - CustomerReceipt/AidParam MDSP - MerchantDisplay MRCP - MerchantReceipt/AidParam - `content` string — Text of the display and/or print message text from gateway. - `merchant` object - `id` string — Unique identifier of the merchant. - `externalReferenceId` string — External reference identifier, if associated with the refund. - `authCode` string — Acquirer-generated authorization code. - `status` 'FAIL' | 'SUCCESS' | 'PENDING' — Status of the refund. Values: Fail Success Pending - `oceanGatewayInfo` object — India-region specific Ocean Gateway information. - `tranSource` string — Transaction source returned from Ocean in the transaction notification. - `tranChannel` string — LPM type information returned from Ocean in the transaction notification. - `transactionType` string — Transaction type information returned from Ocean in the transaction notification. - `merchantId` string — Merchant identifier returned from Ocean in the transaction notification. - `terminalId` string — Terminal identifier returned from Ocean in the transaction notification. - `tenderType` string — Tender type information returned from Ocean in the transaction notification for a transaction. - `entryMethod` string — Entry method returned from Ocean in the transaction notification. - `transactionAmount` string — Transaction amount returned from Ocean in the transaction notification. - `transactionCurrency` string — Transaction currency returned from Ocean in the transaction notification. - `fpTransactionId` string — Ocean-generated transaction identifier. - `merchantTxnId` string — Clover-assigned payment reference identifier for a transaction. - `fpRefundTransactionId` string — Refund transaction identifier returned from Ocean for a transaction. - `transactionStatus` string — Transaction status returned from Ocean in the transaction notification. - `transactionStatusDescription` string — Transaction status description returned from Ocean in the transaction notification. - `rrn` string — Bank registration number (RRN) is a transaction identifier or a reference number provided by the bank to track the transaction status. This RRN is returned from Ocean in the transaction notification. Format: 12 digits - `batchNo` string — Batch number returned from Ocean in the transaction notification. - `invoiceNo` string — Invoice number returned from Ocean in the transaction notification. - `cardScheme` string — Customer local payment method (LPM) information returned from Ocean in the transaction notification. - `qrType` string — QR type,either static or dynamic information, returned from Ocean in the transaction notification. - `transactionDateTime` string — Date transaction was completed, returned from Ocean in the transaction notification. - `authCode` string — Authorization code returned from Ocean in the transaction notification. - `pan` string — Primary account number (PAN) information such as masked virtual payment address, vehicle information, and userId returned from Ocean in the transaction information. - `customerMobile` string — Customer mobile information returned from Ocean in the transaction information. - `customerName` string — Customer name returned from Ocean in the transaction notification. - `customerRemarks` string — Customer remarks returned from Ocean in the transaction notification. - `bankName` string — Name of the bank returned from Ocean in the transaction notification. - `bankCode` string — Bank code returned from Ocean in the transaction notification. - `emiDetails` object — Equated Monthly Installment (EMI) details of a customer returned from Ocean in the transaction notification. - `lenderName` string — Lender who issued the equated monthly installment (EMI). - `tenure` string — Total EMI tenure. - `interestRate` string — Interest rate charged as part of EMI. - `interest` string — Interest amount charged as part of EMI. - `emiAmount` string — EMI amount per month. - `lenderLoanId` string — Lender loan identifier (Id) for the EMI. - `fees` string — Processing fee charged for EMI. - `discountAmount` string — Discount amount provided for EMI. - `offerCashback` string — Offer cashback amount provided for EMI. - `tranAmount` string — Total transaction amount. - `totalPayable` string — Total payable amount which is total EMI with interest. - `reason` string — Reason for initiation of refund. - `note` string — Note for the refund. - `lineItemPayments` object[] — Payment line items. - `id` string — Line item unique identifier. - `percentage` integer — Percent of the line item covered by the payment. - `binName` string — Bank identification number (BIN) indicating the financial institution for the line item. - `refunded` boolean — Indicates whether the payment is refunded. Values: True False - `authorization` object — Authorization to which the payment is associated, for example, opening or closing payment. - `id` string — Unique identifier. - `voidPaymentRef` object — If voided, the corresponding successful payment, and vice versa. - `id` string — Unique identifier. - `voidReason` 'USER_CANCEL' | 'TRANSPORT_ERROR' | 'REJECT_SIGNATURE' | 'REJECT_PARTIAL_AUTH' | 'NOT_APPROVED' | 'FAILED' | 'AUTH_CLOSED_NEW_CARD' | 'DEVELOPER_PAY_PARTIAL_AUTH' | 'REJECT_DUPLICATE' | 'REJECT_OFFLINE' | 'GIFTCARD_LOAD_FAILED' | 'USER_GIFTCARD_LOAD_CANCEL' | 'DEVELOPER_PAY_TIP_ADJUST_FAILED' | 'USER_CUSTOMER_CANCEL' | 'FRAUD' | 'REJECT_GREATER_APPROVED_AMOUNT' | 'TIMEOUT' — Reason for void transaction, if applicable. - `voidReasonDetails` object — Detailed explanation of void transaction reason. - `txError` string — Transaction error bytes. - `voidReasonCode` 'CANCEL_PAYMENT_ADJUST' | 'BREAK_RESET' | 'CANCEL' | 'AUTH_FAILED' | 'NETWORK_FAILED' | 'NON_OK_RESULT_CODE_RETURNED_FROM_VERIFY_CVM' | 'PARTIAL_AUTH_NOT_ALLOWED' | 'PARTIAL_AUTH_CANCELLED' | 'QUICK_CHIP_DECLINE' | 'KERNEL_DECLINE' | 'NON_OK_RESULT_CODE_FROM_FORCE_ACCEPT' | 'MERCHANT_CANCELLED_THE_FORCE_ACCEPTANCE' | 'CARD_READER_ERROR' | 'UNKNOWN_EXCEPTION' | 'ERROR_EVENT' | 'KERNEL_EXCEPTION' | 'FATAL_EXCEPTION' | 'CARD_CHECK_FAILED_FOR_REVERSAL' | 'MANUAL_ENTRY_NOT_ALLOWED' | 'MANUAL_ENTRY_NOT_ALLOWED_FOR_CARD' | 'SWIPE_CARD_CHECK_FAILED_FOR_REVERSAL' | 'OFFLINE_AUTH_FAILED' | 'TXN_STATUS_DECLINED' | 'COMPLETION_DEVICE' | 'NON_OK_RESULT_CODE_FROM_DUPLICATE_CHECK' | 'MERCHANT_CANCELLED_THE_DUPLICATE_CHECK' | 'NON_OK_RESULT_CODE_RETURNED_FROM_OFFLINE_SCREEN' | 'MERCHANT_CANCELLED_OFFLINE_PAYMENT' | 'OFFLINE_AUTH_FAILED_ON_CARD_PRESENT_REVERSAL' | 'QUICK_CHIP_TIME_OUT' | 'HANDLE_PAY_STATE' | 'HANDLE_CONTACT_REQUIRED' | 'FINALIZE' | 'HANDLE_CARD_DECLINED_TXN_STATUS' | 'MERCHANT_REASON' — Detailed reason code for void transaction. - `description` string — Additional description of the reason for void transaction. - `descriptionEnum` string — Additional description and values for a void transaction. - `payFailureMessage` string — Pay failure message. - `dccInfo` object — Dynamic currency conversion information. - `inquiryRateId` integer — Identifier assigned to the rate inquiry. - `dccApplied` boolean — Indicates whether dynamic currency conversion (DCC) is applied to the transaction. Values: True False - `foreignCurrencyCode` string — Currency code for the foreign currency amount. - `foreignAmount` integer — Amount in foreign currency. - `exchangeRate` number — Exchange rate to calculate the currency conversion. - `marginRatePercentage` string — Percentage of the margin rate. - `exchangeRateSourceName` string — Source to calculate the currency exchange rate. - `exchangeRateSourceTimeStamp` string — Time stamp on the source to calculate the currency exchange rate. - `dccEligible` boolean — Indicates whether the transaction is eligible for dynamic currency conversion. Values: True False - `exchangeRateId` string — Unique identifier of the currency exchange rate. - `rateRequestId` string — Identifier assigned to the rate request. - `baseAmount` integer — Amount of the base transaction. - `baseCurrencyCode` string — Currency code of the base transaction amount. - `transactionSettings` object — Per transaction settings for the payment. - `cardEntryMethods` integer — Number of card entry methods. - `disableCashBack` boolean — Indicates whether cashback is disable. Default: False; cashback is not disabled. - `cloverShouldHandleReceipts` boolean — Indicates whether Clover is responsible for handling transaction receipts. Default: True. - `forcePinEntryOnSwipe` boolean — Indicates whether card pin is required or not. Default: False. - `disableRestartTransactionOnFailure` boolean — Indicates whether transaction should be restarted in case of failure. Default: False. - `allowOfflinePayment` boolean — Indicates whether offline payments is allowed or not. Default: False. - `approveOfflinePaymentWithoutPrompt` boolean — Indicates whether offline payment is approved without consent. Default: False. - `forceOfflinePayment` boolean — Indicates whether offline payment was the only option. Default: False. - `signatureThreshold` integer — Indicates number of signatures allowed - `signatureEntryLocation` 'ON_SCREEN' | 'ON_PAPER' | 'NONE' — Indicates the mode of signature. Values: On screen On paper None - `tipMode` 'TIP_PROVIDED' | 'ON_SCREEN_BEFORE_PAYMENT' | 'ON_SCREEN_AFTER_PAYMENT' | 'ON_PAPER' | 'NO_TIP' — Mode of tip been paid. - `tippableAmount` integer — Amount paid in tips. - `disableReceiptSelection` boolean — Indicates whether receipts are allowed or not. Default: False. - `disableDuplicateCheck` boolean — Indicates whether duplicates checks are required or not. Default: False. - `autoAcceptPaymentConfirmations` boolean — If set to true, confirmation requests triggered by a challenge at the payment gateway are automatically accepted, and confirmation requests are not transmitted back to the calling program. Be sure you are willing to accept the risk associated with accepting offline or duplicate payment challenges. See https://docs.clover.com/build/working-with-challenges for more information. - `autoAcceptSignature` boolean — Indicates whether auto accept signature is required or not. Default: False. - `returnResultOnTransactionComplete` boolean — Indicates whether confirmation result is required or not. Default: False. - `tipSuggestions` object[] — Indicates tip information. - `id` string — Unique identifier of the tip. - `name` string — Name of the tip. - `percentage` integer — Suggested tip percentage. - `amount` integer — Suggested tip amount. - `isEnabled` boolean — Indicates if the tip is enabled or not. - `flatTip` integer — Suggested flat tip amount. - `cashbackSuggestions` object[] — indicates cashback related information. - `amount` integer — Suggested cashback amount. - `regionalExtras` object — Indicates any regional information. - `default` string - `disableCreditSurcharge` boolean — Indicates whether credit surcharge is disable or not. Default: False. - `receiptOptions` object — Indicates the mode of receipts. - `default` string - `remoteReceipts` boolean — Indicates whether remote receipt are required or not. - `germanInfo` object — German region-specific information. - `cardTrack2` string - `cardSequenceNumber` string - `transactionCaseGermany` string - `transactionTypeGermany` string - `terminalID` string - `traceNumber` string - `oldTraceNumber` string - `receiptNumber` string - `transactionAID` string - `transactionMSApp` string - `transactionScriptResults` string - `receiptType` string - `customerTransactionDOLValues` string - `merchantTransactionDOLValues` string - `merchantJournalDOL` string - `merchantJournalDOLValues` string - `configMerchantId` string - `configProductLabel` string - `hostResponseAidParBMP53` string - `hostResponsePrintDataBM60` string - `sepaElvReceiptFormat` string - `sepaElvExtAppLabel` string - `sepaElvPreNotification` string - `sepaElvMandate` string - `sepaElvCreditorId` string - `sepaElvMandateId` string - `sepaElvIban` string - `appTracking` object — Tracking information for the app that created this payment. - `developerAppId` string — Uuid from the developer application. This is typically populated and used only on the back end. - `applicationName` string — Name of the developer application. - `applicationID` string — String representing an application. - `applicationVersion` string — String representing a semanticversion. See http://semver.org/ - `sourceSDK` string — String representing a SDK. - `sourceSDKVersion` string — String representing a SDK. See http://semver.org/ - `cashAdvanceExtra` object — Information specific to cash advance transactions. - `cashAdvanceSerialNum` string — Indicates details for advance cash been obtained. - `cashAdvanceCustomerIdentification` object — Indicates customer details who has obtained cash in advance. - `idType` 'DRIVERS_LICENSE' | 'PASSPORT' | 'US_MILITARY_ID' | 'US_RESIDENT' | 'CONSULAR_ID' | 'CANADIAN_CITIZEN' | 'US_STATE_GOVT_ID' | 'OTHER_ID' - `serialNumber` string — Identification serial number. - `maskedSerialNumber` string — Masked identification serial number. - `encryptedSerialNumber` string — Encrypted identification serial number. - `expirationDate` string — Expiration date in format MMDDYYYY. - `issuingState` string — State in which identification was issued. - `issuingCountry` string — Country in which identification was issued. - `customerName` string — Customer's full name. - `addressStreet1` string — Customer's address lane one. - `addressStreet2` string — Customer's address lane two. - `addressCity` string — Customer's city. - `addressState` string — Customer's state. - `addressZipCode` string — Customer's zip code. - `addressCountry` string — Customer's country. - `tellerID` integer — Employee identification number. - `transactionInfo` object — Transaction information - `languageIndicator` string — 2 character language used for the transaction. Deprecated in factor of transactionLocale. - `transactionLocale` string — Locale for the transaction (e.g. en-CA) - `accountSelection` 'CREDIT' | 'DEBIT' | 'CHECKING' | 'SAVINGS' — Type of account. - `fiscalInvoiceNumber` string — Consists of 4-digits prefix + 8-digits. - `installmentsQuantity` integer — Indicates number of installments. - `installmentsPlanCode` string — Indicates plan in the alpha numuric code. - `installmentsPlanId` string — Indicates selected plan identifier. - `installmentsPlanDesc` string — Indicates selected plan desc. - `cardTypeLabel` string — Card type label. - `cardSymbol` string — Card Symbol for identify in payment_card_config table. - `stan` integer — STAN(System Audit Trace Number). - `identityDocument` object — Customers identification number and type. - `id` string — Unique identifier. - `type` string — Type of personal identification: National Document, Passport, etc - `number` string — Identification number. - `createdTime` integer — Created timestamp. - `modifiedTime` integer — Modified timestamp. - `deletedTime` integer — Deleted timestamp. - `payment` object - `id` string — Unique identifier. - `batchNumber` string — Indicates transaction Batch number. - `receiptNumber` string — Indicates transaction Receipt number. - `reversalStanRefNum` string — Reversal STAN (STAN(system audit trace number) ref number. - `reversalStan` integer — STAN for reversal. - `reversalMac` string — MAC for reversal. - `reversalMacKsn` string — MAC KSN for reversal. - `terminalIdentification` string — Designates the unique location of a terminal at a merchant. - `externalTerminalId` string — Main internal identifier of terminal which should be the same across all Fiserv’s components. - `merchantIdentifier` string — When concatenated with the Acquirer Identifier, uniquely identifies a given merchant. - `merchantNameLocation` string — Indicates the name and location of the merchant. - `maskedTrack2` string — Masked track2 data. - `receiptExtraData` string — Extra data for receipt. - `selectedService` 'NONE' | 'PAYMENT' | 'REFUND' | 'CANCELLATION' | 'PRE_AUTH' | 'UPDATE_PRE_AUTH' | 'PAYMENT_COMPLETION' | 'CASH_ADVANCE' | 'DEFERRED_PAYMENT' | 'DEFERRED_PAYMENT_COMPLETION' | 'VOICE_AUTHORISATION' | 'CARDHOLDER_DETECTION' | 'TOKEN_REQUEST' | 'VERIFICATION' — Defines the Financial Service selected for the transaction. - `transactionResult` 'APPROVED' | 'DECLINED' | 'ABORTED' | 'VOICE_AUTHORISATION' | 'PAYMENT_PART_ONLY' | 'PARTIALLY_APPROVED' | 'NONE' — Result of the transaction. - `transactionTags` string — Contains a hex string with needed TLV tags for certification. - `txFormat` 'DEFAULT' | 'NEXO' — Contains the information how the data inside transactionTags should be coded - initially we cause default and nexo as formats. - `panMask` string — Contains the information how the PAN should masked. - `transactionSequenceCounter` string — Counter maintained by the terminal that is incremented for each transaction at the beginning of the Perform Service function. - `applicationPanSequenceNumber` string — Identifies and differentiates cards with the same PAN. - `reversalReason` 'CHIP_DECLINE' | 'CARDHOLDER_CANCELLATION' | 'COMMUNICATION_ERROR' | 'OTHER_REASON' — Contains the reason why the transaction should be reversed in the host. It has to be mapped in server with the expected value by the corresponding gateway. - `isTokenBasedTx` boolean — Boolean to determine if the transaction done using a vaulted card is a token based transaction. - `origTransactionSequenceCounter` string — For reversal and capture transactions, this contains the reference (transactionSequenceCounter) to the originating transaction. - `transactionSequenceCounterUpdate` string — This field is populated when the TSC of a terminal is out of sync and is provided with an update. - `emergencyFlag` boolean — Boolean value defining if the corresponding TX was performed in NEXO emergency mode according NEXO IS Spec chapter 10.2. - `entryType` 'SWIPED' | 'KEYED' | 'VOICE' | 'VAULTED' | 'OFFLINE_SWIPED' | 'OFFLINE_KEYED' | 'EMV_CONTACT' | 'EMV_CONTACTLESS' | 'MSD_CONTACTLESS' | 'PINPAD_MANUAL_ENTRY' | 'QR_CODE' | 'SCANNED' — This field contains the entry type of a transaction. - `promotionalMessage` object - `message` string — Indicates promotion message. - `showOnMerchantReceipt` boolean — Indicates whether message should be displayed on the merchant receipt or not. Value: True False. - `showOnCustomerReceipt` boolean — Indicates whether message should be displayed on the customer receipt or not. Value: True False. - `showOnDisplay` boolean — Indicates whether message should be displayed on the disply or not. Value: True False. - `sepaElvTransactionInfo` object - `receiptFormat` string — Value of tag E1.DF8206 from NEXO config. - `extAppLabel` string — Value of tag E6.DF8211 or E6.DF8212 (Online or Offline TX printout). - `preNotification` string — Value of tag E6.DF8214 info form NEXO config. - `mandate` string — Value of tag E6.DF8215 info from NEXO config. - `creditorId` string — Value of tag E6.DF8216 info from NEXO config. - `mandateId` string — Generated by SPA according to ELV – TBD: use Trace number instead of receipt number. - `iban` string — Received in ICC related data from IPG (tag 5F53). - `isMerchantForced` boolean — Defines if the corresponding SEPA ELV TX was forced by the merchant (override defined limit) - `clientCardType` 'VISA' | 'MC' | 'AMEX' | 'DISCOVER' | 'DINERS_CLUB' | 'JCB' | 'MAESTRO' | 'SOLO' | 'LASER' | 'CHINA_UNION_PAY' | 'CARTE_BLANCHE' | 'UNKNOWN' | 'GIFT_CARD' | 'EBT' | 'GIROCARD' | 'INTERAC' | 'OTHER' | 'RUPAY' — Client card type should be used only limited purpose only and should not be confused with cardType in other objects. This is a read only field and must not to be overwritten on server or client once set on client. This is set on client only for MSR tx for now as the AIDs are not identified for MSR. For few MSR tx, the card type was identified incorrectly on client side, and also on server side based on the bin match. In order to get the correct card types, this client card type will be sent to the server - `explicitlySelectedApp` string — The app explicitly selected by the customer via the choice button. - `isSepaElv` boolean — Defines if the corresponding TX was performed as SEPA ELV TX. - `cardEntryType` 'SWIPED' | 'KEYED' | 'VOICE' | 'VAULTED' | 'OFFLINE_SWIPED' | 'OFFLINE_KEYED' | 'EMV_CONTACT' | 'EMV_CONTACTLESS' | 'MSD_CONTACTLESS' | 'PINPAD_MANUAL_ENTRY' | 'QR_CODE' | 'SCANNED' — Defines if the corresponding TX was performed as SEPA ELV TX. - `printMessages` object[] - `destination` 'CUSTOMER_DISPLAY' | 'CUSTOMER_RECEIPT' | 'CUSTOMER_RECEIPT_AID_PARAM' | 'MERCHANT_DISPLAY' | 'MERCHANT_RECEIPT' | 'MERCHANT_RECEIPT_AID_PARAM' — Destination for the message CDSP - CustomerDisplay, CRCP - CustomerReceipt/AidParam, MDSP - MerchantDisplay, MRCP - MerchantReceipt/AidParam - `content` string — Contains the display and/or print message text from gateway. - `signatureDisclaimer` object — Information displayed to customers for storing electronic signatures. - `disclaimerText` string - `disclaimerValues` object — Values that will be substituted in standard disclaimer text (txn date/time, account number, product label, etc. - `default` string - `externalReferenceId` string — External reference identifier (ID) if associated with the payment. - `merchant` object - `id` string — Unique identifier. - `increments` object[] — Indicates if there is any increment in the refund amount. - `id` string — Unique identifier - `amount` integer — Amount of the incremental authorization, includes additional charges in database. - `cardTransaction` object - `cardType` 'VISA' | 'MC' | 'AMEX' | 'DISCOVER' | 'DINERS_CLUB' | 'JCB' | 'MAESTRO' | 'SOLO' | 'LASER' | 'CHINA_UNION_PAY' | 'CARTE_BLANCHE' | 'UNKNOWN' | 'GIFT_CARD' | 'EBT' | 'GIROCARD' | 'INTERAC' | 'OTHER' | 'RUPAY' — Type of card used for the transaction. - `entryType` 'SWIPED' | 'KEYED' | 'VOICE' | 'VAULTED' | 'OFFLINE_SWIPED' | 'OFFLINE_KEYED' | 'EMV_CONTACT' | 'EMV_CONTACTLESS' | 'MSD_CONTACTLESS' | 'PINPAD_MANUAL_ENTRY' | 'QR_CODE' | 'SCANNED' — Indicates the type of entry made for the card. For example: swiped, vaulted, scanned, and so on. - `first6` string — First 6-digits of the card number. - `last4` string — Last 4-digits of the card number. - `type` 'AUTH' | 'PREAUTH' | 'PREAUTHCAPTURE' | 'ADJUST' | 'VOID' | 'VOIDRETURN' | 'RETURN' | 'REFUND' | 'NAKEDREFUND' | 'GETBALANCE' | 'BATCHCLOSE' | 'ACTIVATE' | 'BALANCE_LOCK' | 'LOAD' | 'CASHOUT' | 'CASHOUT_ACTIVE_STATUS' | 'REDEMPTION' | 'REDEMPTION_UNLOCK' | 'RELOAD' | 'CASH_ADVANCE' | 'VOID_CREDIT' | 'REFUND_CREDIT' | 'INTERNET_ACTIVATE' | 'TOKEN_REQUEST' | 'VERIFICATION' — Indicates the type of transaction used by the card. - `authCode` string — Indicates the authorization code if successful. - `referenceId` string — Card transaction reference identifier. - `transactionNo` string — Card transaction number. - `state` 'PENDING' | 'CLOSED' — Indicates the status of the transaction. - `extra` object — Indicates extra information to be stored as part of gateway/card transaction. - `default` string — Indiactes any default message that will be appeared. - `begBalance` integer — Indicates the available balance in the card. - `endBalance` integer — Indicates the remaining balance in the card. - `avsResult` 'SUCCESS' | 'ZIP_CODE_MATCH' | 'ZIP_CODE_MATCH_ADDRESS_NOT_CHECKED' | 'ADDRESS_MATCH' | 'ADDRESS_MATCH_ZIP_NOT_CHECKED' | 'NEITHER_MATCH' | 'SERVICE_FAILURE' | 'SERVICE_UNAVAILABLE' | 'NOT_CHECKED' | 'ZIP_CODE_NOT_MATCHED_ADDRESS_NOT_CHECKED' | 'ADDRESS_NOT_MATCHED_ZIP_CODE_NOT_CHECKED' — Indicates the status of the transaction. - `cardholderName` string — Indicates the card holder name for which payment is to be made. - `token` string — Indicates the token number of the card. - `vaultedCard` object — Vaulted card which can be used for subsequent transactions. - `first6` string, required — First 6-digits of the vaulted card. - `last4` string, required — Last 4-digits of the vaulted card. - `cardholderName` string — Card holder name of the vaulted card. - `expirationDate` string — Expiry date of the vaulted card. - `token` string — Token number of the vaulted card. - `gatewayTxState` 'INITIATED' | 'INITIATED_ON_AUTH' | 'ACKNOWLEDGED' | 'CONNECT_FAILED' | 'TIMEOUT' | 'FAILED' | 'REVERSE_INITIATED' | 'REVERSE_INITIATED_ON_AUTH' | 'REVERSED' | 'REVERSAL_FAILED' | 'EXTERNAL' — The state as currently recorded. This differs from the legacy 'state' field. The legacy 'state' field is calculated from the 'type' field and whether the transaction was captured. - `currency` string — Currency code. - `captured` boolean — Indicates whether the transaction was captured by the gateway or not. - `debitRefund` object — Indicates refund parameters required for debit card refunds. - `debitTransactionRouteInd` string — Route of the the payment transaction. - `isDebitTransactionRefundable` boolean — True, if debitTransactionRouteInd is C, else, its determined by the EDS entitlement rule for D/S - `result` 'SUCCESS' | 'FAIL' | 'INITIATED' | 'VOIDED' | 'VOIDING' | 'VOID_FAILED' | 'AUTH' | 'AUTH_COMPLETED' | 'DISCOUNT' | 'OFFLINE_RETRYING' | 'PENDING' — Result of the incremental authorization. - `createdTime` integer — Created time on the server. - `employee` object — Employee who processed the incremental authorization. - `id` string — Unique identifier. - `incrementAmount` integer — Amount of the incremental authorization. - `purchaseCardL2` object — Purchase card level-2 data. - `taxAmount` integer — Sales tax amount. - `taxIndicator` 'UNKNOWN' | 'TAXABLE' | 'NON_TAXABLE' — Taxable status - `vatTaxAmount` integer — Tax amount for freight/shipping. - `vatTaxRate` integer — Tax rate on freight/shipping amount. - `purchaseIdentifier` string — Purchase identifier for customer/merchant. - `pcOrderNumber` string — Purchase card customer code. - `discountAmount` integer — Applied discount amount. - `freightAmount` integer — Freight amount. - `dutyAmount` integer — Duty amount. - `destinationPostalCode` string — Destination postal code. - `shipFromPostalCode` string — Ship from postal code. - `destinationCountryCode` string — Destination country code. - `merchantTaxId` string — Merchant tax id. - `productDescription` string — Description of the product. - `purchaseCardL3` object — Purchase card level-3 data. - `serviceCode` string — Service code extracted from the track data in Field 35. For all card types, Service code is mandatory for all merchants who directly settle through First Data. - `magneticStripeInd` boolean — If the card was swiped via magnetic strip reader for payment, set this indicator true. Also, serviceCode will be mandatory if this is true. - `level3LineItems` object[] — List of line items constituting the order using Level-3 Purchase card. - `itemDescription` string — Level-3 - Line Item Merchandise Description, upto 26 characters. - `productCode` string — Item product code. - `unitCost` integer — Line item price. - `quantity` integer — Line item quantity. - `discountAmount` integer — Item discount. - `unitOfMeasure` string — Line item unit of measure. - `commodityCode` string — Line item commodity code. - `oceanGatewayInfo` object — India-region specific Ocean Gateway information. - `tranSource` string — This field contains transaction source returned from Ocean as part of notification for a transaction. - `tranChannel` string — This field contains LPM type information returned from Ocean as part of notification for a transaction. - `transactionType` string — This field contains transaction type information returned from Ocean as part of notification for a transaction. - `merchantId` string — This field contains MerchantId returned from Ocean as part of notification for a transaction. - `terminalId` string — This field contains TerminalId returned from Ocean as part of notification for a transaction. - `tenderType` string — This field contains tender type information returned from Ocean as part of notification for a transaction. - `entryMethod` string — This field contains the entry method returned from Ocean as part of notification for a transaction. - `transactionAmount` string — This field contains the transaction amount returned from Ocean as part of notification for a transaction. - `transactionCurrency` string — This field contains the transaction currency returned from Ocean as part of notification for a transaction. - `fpTransactionId` string — This field contains the ocean generated transaction Id for a transaction. - `merchantTxnId` string — This field contains the payment reference id provided by clover for a transaction. - `fpRefundTransactionId` string — This field contains the refund transaction id returned from Ocean for a transaction. - `transactionStatus` string — This field contains the transaction status returned from Ocean as part of notification for a transaction. - `transactionStatusDescription` string — This field contains the transaction status description returned from Ocean as part of notification for a transaction. - `rrn` string — This field contains rrn number (reference provided by bank) returned from Ocean as part of notification for a transaction. - `batchNo` string — This field contains batch number returned from Ocean as part of notification for a transaction. - `invoiceNo` string — This field contains invoice number returned from Ocean as part of notification for a transaction. - `cardScheme` string — This field contains Customer LPM information returned from Ocean as part of notification for a transaction. - `qrType` string — This field contains qr tpe either static or dynamic information returned from Ocean as part of notification for a transaction. - `transactionDateTime` string — This field contains transaction completion date information returned from Ocean as part of notification for a transaction. - `authCode` string — This field contains authorization Code returned from Ocean as part of notification for a transaction. - `pan` string — This field contains pan information like masked virtual payment address,vehicle info,userId returned from Ocean as part of notification for a transaction. - `customerMobile` string — This field contains customer mobile info returned from Ocean as part of notification for a transaction. - `customerName` string — This field contains customer name returned from Ocean as part of notification for a transaction. - `customerRemarks` string — This field contains customer remarks returned from Ocean as part of notification for a transaction. - `bankName` string — This field contains name of the bank returned from Ocean as part of notification for a transaction. - `bankCode` string — This field contains bank code returned from Ocean as part of notification for a transaction. - `emiDetails` object — This field indicates the EMI details of a customer returned from Ocean as part of notification for a transaction. - `lenderName` string — This field contains the equated monthly installment (EMI) lender name. - `tenure` string — This field contains total EMI tenure. - `interestRate` string — This field contains interest rate charged as part of EMI. - `interest` string — This field contains interest amount charged as part of EMI. - `emiAmount` string — This field contains EMI amount per month. - `lenderLoanId` string — This field contains lender loan id for the EMI. - `fees` string — This field contains processing fee charged for EMI. - `discountAmount` string — This field contains discount amount provided for EMI. - `offerCashback` string — This field contains offer cashback amount provided for EMI. - `tranAmount` string — This field contains total transaction amount. - `totalPayable` string — This field contains total payable amount which is total EMI with interest. - `terminalManagementComponents` object[] — Terminal management components as defined by nexo standards that contain general information on the terminal, the installed payment app, and so on. - `type` 'ACQUIRER_PROTOCOL_PARAMS' | 'APPLICATION_PARAMS' | 'TERMINAL_PARAMS' | 'SECURITY_PARAMS' | 'SERVER' | 'TERMINAL' | 'DEVICE' | 'SECURE_MODULE' | 'PAYMENT_APPLICATION' | 'EMV_KERNEL' | 'EMV_LEVEL1' | 'MIDDLEWARE' | 'DRIVER' | 'OPERATING_SYSTEM' | 'MERCHANT_PARAMS' | 'CERTIFICATE_PARAMS' | 'TMS_PROTOCOL_PARAMS' — Application type of terminal management components. - `itemNumber` string — Item number of components. - `provider` string — Provider of components. - `serial` string — Serial number of components. - `version` string — Version of components. - `identification` string — Identification number of components. - `standard` object — Standard and assessment information for the component. - `component` string — Component standard, for example, C-2. - `identification` string — Standard identifier, for example, EMV ICC Specifications. - `version` string — Standard version. - `issuer` string — Standard issuer. - `type` string — Assessment type for the standard. - `assigner` string — Assessment assigner. - `assessmentIdentifier` string — Approval number or other identifier for the assessment. - `emiInfo` object — Associated equated monthly installment (EMI) information. - `mobileNumber` string — Customer’s mobile number. - `indicator` string — EMI Indicator - `transactionAmount` integer — Indicates trasnsaction amount. - `productAmount` integer — Full product amount (without discount). - `discountAmount` integer — Discount offered for the product. - `tenure` integer — Tenure in months. - `interestRate` number — Indicates the interest rate on the EMI. - `interestAmount` integer — Indicates the interest amount on the EMI. - `processingFee` integer — Indicates the processing fee applicable for the EMI transaction. - `totalAmount` integer — Total amount to be paid by a customer, i.e., EMI per month mutliply by Tenure. - `amountPerMonth` integer — Transaction amount per month. --- [API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/versions/08da265101a3/schema)