--- title: "Get a list of credit refunds" method: GET path: "/v3/merchants/{mId}/credit_refunds" tags: ["PAYMENTS"] --- # Get a list of credit refunds `GET /v3/merchants/{mId}/credit_refunds` Displays a list of credit refunds associated with a payment, including taxes and tips. ## Path parameters - `mId` string, required ## Query parameters - `expand` string ## Headers - `User-Agent` string, required ## Response `200` Successful response. Credit refunds list is displayed. - object - `id` string — Unique identifier of the refund. - `orderRef` object — The order with which the credit is associated. - `id` string — Reference number of the order with which the refund is associated. - `device` object — Universally unique identifier (UUID) of the device that processed the transaction for this refund. This UUID is different from the Clover-assigned base-13 device Id. Format: 128-bit UUID - `id` string — Unique identifier. - `tender` object — Tender type associated with this payment. For example: credit card, cash, and so on. - `id` string — Unique identifier. - `editable` boolean — Indicates whether the merchant tender type is editable. Values: True False - `labelKey` string — Label key. - `label` string — Label key. - `opensCashDrawer` boolean — Indicates that tender is opening the cash drawer. - `supportsTipping` boolean — Indicates whether tipping is allowed on the payment using the tender type. - `enabled` boolean — Indicates that merchant tender is enabled. - `visible` boolean — Indicates that merchant tender is visible. - `instructions` string — Instructions for how to process tender. - `employee` object — Employee who processed the payment. - `id` string — Unique identifier of the employee. - `customers` object — Customer who received the credit/refund - `id` string — Unique identifier of the customer. - `merchant` object — Merchant associated with this customer. - `id` string — Unique identifier of the merchant. - `firstName` string — First name of the customer. Note: Length of first name cannot be more than 64 characters. - `lastName` string — Last name of the customer. Note: Length of last name cannot be more than 64 characters. - `marketingAllowed` boolean — Indicates Whether customer allows receiving of marketing communication. - `customerSince` integer — Tenure since customer associated with the merchant. - `orders` object[] — Customer's orders. - `id` string — Unique identifier of the item. - `addresses` object[] — Customer's address. Note: Address cannot be null and should not be more than 127 characters long. - `address1` string — Customer's address, line one. - `address2` string — Customer's address, line two. - `address3` string — Customer's address, line three. - `city` string — Customer's city. - `country` string — Customer's country. - `state` string — Customer's state. - `zip` string — Postal code of the customer's address. - `emailAddresses` object[] — Customer's email address. - `id` string — Email identifier of the customer. - `emailAddress` string, required — Email address of the customer. Note: A valid email address is required. . Email address domains are validated using the [Apache Domain Validator](https://commons.apache.org/proper/commons-validator/apidocs/org/apache/commons/validator/routines/DomainValidator.html). . Customer email addresses are validated using the [Apache Email Validator](https://commons.apache.org/proper/commons-validator/apidocs/org/apache/commons/validator/routines/EmailValidator.html). - `verifiedTime` integer — Time when the customer's email address was verified as valid. - `primaryEmail` boolean — Customer's primary email address. - `customer` object — Name of the customer who provided the email address. - `id` string — Unique identifier. - `phoneNumbers` object[] — Customer's phone numbers. - `id` string — Phone number identifier. - `phoneNumber` string, required — Customer's phone number. - `customer` object — Customer name associated with the phone number. - `id` string — Unique identifier. - `cards` object[] — Customer's card details. - `id` string — Card identifier. - `first6` string, required — First 6 digits of the customer's card. - `last4` string, required — last 4 digits of the customer's card. - `firstName` string — First name on the customer's card. - `lastName` string — Last name on the customer's card. - `expirationDate` string — Expiry date of the customer's card. - `additionalInfo` object — Additional information for the customer's card. - `default` string - `cardType` string — Customer's card type. - `token` string — Customer's card token number. Note: Token length cannot be more than 72 characters. - `tokenType` 'MULTIPAY' | 'FINANCIAL' | 'CTOKEN' — Customer's card token type. - `modifiedTime` integer — Time when the card was last updated. - `customer` object — Customer who this card belongs to. - `id` string — Unique identifier. - `metadata` object — Additional information about the customer. - `businessName` string — Name of customer's business. Note: Length of the business name cannot be more than 127 characters. - `note` string — Additional information about the customer. Note: Length of the note cannot be more than 2000 characters. - `dobYear` integer — Optional. Year of the customer’s date of birth. - `dobMonth` integer — Month of the customer’s date of birth. - `dobDay` integer — Day of the customer’s date of birth. - `modifiedTime` integer — Time when the customer data was last updated. - `customer` object — Customer for whom the metadata is saved. - `id` string — Unique identifier. - `amount` integer — Amount paid - `taxAmount` integer — Amount paid in tax - `taxRates` object[] - `id` string — Tax rate identifier. - `name` string — Tax rate name. This field is optional. - `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. 100% = 1e7 or 1 followed by 7 zeros. - `isVat` boolean — Whether the taxable amount includes tax. - `taxAmount` integer — The amount of tax collected. In cases where there are multiple payments for an order then it may be necessary to add an extra cent of tax to the last payment. - `transactionRef` object — The refund with which the tax rate is associated. - `id` string — Unique identifier. - `createdTime` integer — Time payment was recorded on server - `clientCreatedTime` integer - `cardTransaction` object — Information about the card used for credit or debit card payments. - `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 - `voided` boolean - `voidReason` string - `dccInfo` object — Dynamic currency conversion information. - `inquiryRateId` integer — Inquiry rate identifier. - `dccApplied` boolean — Flag indicating whether DCC was applied on this transaction. - `foreignCurrencyCode` string — Indicates foreign currency code. - `foreignAmount` integer — Indicates foreign (transaction) amount. - `exchangeRate` number — Exchange Rate. - `marginRatePercentage` string — Margin Rate Percentage. - `exchangeRateSourceName` string — Exchange Rate Source Name. - `exchangeRateSourceTimeStamp` string — Exchange Rate Source Timestamp. - `dccEligible` boolean — Flag indicating whether DCC was offered on this txn. - `exchangeRateId` string — Exchange rate from the rate request. - `rateRequestId` string — Rate request id from the rate request. - `baseAmount` integer — Amount sent for exchange in rate request. - `baseCurrencyCode` string — Alpha currency code for foreign currency. - `transactionSettings` object — Per transaction settings for the payment. - `cardEntryMethods` integer — Number of card entry method. - `disableCashBack` boolean — Indicates whether cashback is disable or not. Default: False. - `cloverShouldHandleReceipts` boolean — Indicates whether clover is responsible of handling receipts or not. 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. - `creditRefunds` object[] - `id` string — Unique identifier - `orderRef` object — Order with which the refund is associated. - `id` string — Unique identifier. - `device` object — Device which processed the transaction for this refund, a 128-bit UUID, not a normal base-13 Clover ID. - `id` string — Unique identifier. - `createdTime` integer — Time when the refund was recorded on the server. - `clientCreatedTime` integer — Time when the refund was recorded on the client - `credit` object — The credit with which the credit refund is associated - `id` string — Unique identifier. - `employee` object - `id` string — Unique identifier. - `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/ - `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. - `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 credit. - `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/ - `result` 'SUCCESS' | 'FAIL' | 'INITIATED' | 'VOIDED' | 'VOIDING' | 'VOID_FAILED' | 'AUTH' | 'AUTH_COMPLETED' | 'DISCOUNT' | 'OFFLINE_RETRYING' | 'PENDING' - `reason` string — Reason why the credit was initiated - `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. - `merchant` object - `id` string — Unique identifier. - `externalReferenceId` string — External reference identifier, if associated with the credit. - `CreditAttributes` object - `default` string --- [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/revisions/08da265101a3/schema)