Payment response reference

The following table describes the information that can be returned for payments initiated with the Clover Connector sale, auth, preAuth, or voidPayment functions. This is not a comprehensive listing, and some properties are present only when certain transaction parameters are met.

Property

Description

success

Whether the operation was successful

result

The final result of the requested operation

reason

Additional information about the result

message

Detailed information about the result

payment

An object representing the payment

payment.id

The unique identifier of the payment

payment.order.id

The unique identifier of the Clover order associated to the payment

payment.tender.id

The unique identifier of the merchant tender type used for the payment

payment.tender.editable

Whether this merchant tender is editable

payment.tender.labelKey

Internal name of the tender (see Clover tender reference for more information)

payment.tender.label

The name of the tender appearing to the merchant and customer (see Clover tender reference for more information)

payment.tender.opensCashDrawer

Whether a connected cash drawer is opened after the transaction is processed

payment.tender.enabled

Whether the tender type is active for the merchant

payment.tender.visible

Whether the tender type is shown in the Clover Setup app

payment.tender.instructions

Steps for the merchant to follow when accepting this tender type

payment.amount

Number of cents representing the order subtotal

payment.tipAmount

Number of cents added as a tip

payment.taxAmount

Number of cents collected for taxes. This is included in the subtotal shown in the payment.amount field.

payment.cashbackAmount

Number of cents given to the customer as cash

payment.cashTendered

Number of cents provided by the customer as cash

payment.externalPaymentId

A unique identifier sent by your POS with the transaction request. See Tracking transactions with external IDs for more information.

payment.employee.id

The unique identifier of the employee that processed the payment

payment.createdTime

Unix timestamp of when the payment record was created

payment.offline

Whether the payment was processed when the Clover device was in the offline state. For general information about offline payments, see Take payments while offline in the merchant help. For information about offline payment settings in the SDK, see the Per-transaction settings page.

payment.result

The final result of the requested operation

payment.cardTransaction

An object containing information about the card presented by the customer to complete the payment

payment.cardTransaction.cardType

The brand of card used for the payment

payment.cardTransaction.entryType

The way the card information was entered at the Clover device. These options can be controlled with the CardEntryMethods per-transaction setting.

payment.cardTransaction.first6

First six digits of the card number

payment.cardTransaction.last4

Last four digits of the card number

payment.cardTransaction.type

The transaction type recorded by the payment gateway

payment.cardTransaction.authCode

The authorization code returned by the card issuer

payment.cardTransaction.referenceId

The reference identifier returned by the card issues

payment.cardTransaction.transactionNo

The transaction identifier returned by the card issues

payment.cardTransaction.state

The current status of the payment (either PENDING or CLOSED)

payment.cardTransaction.extra

An object containing additional details about the card transaction

payment.cardTransaction.extra.applicationLabel

The label associated with the card's AID (chip and contactless only)

payment.cardTransaction.extra.applicationIdentifier

The AID of the card product selected for use to process the transaction (chip and contactless only)

payment.cardTransaction.extra.cvmResult

The outcome of the card verification process (for example, SIGNATURE_VERIFIED or ONLINE_PIN)

payment.cardTransaction.extra.authorizingNetworkName

The name of the card network that processed the transaction request

payment.cardTransaction.cardholderName

Full name of the cardholder

payment.cardTransaction.token

A reusable, tokenized representation of the card. This is returned only when the merchant is configured for multipay tokens.

payment.cardTransaction.vaultedCard

An object containing data about the customer's tokenized card. This is returned only for merchants that are configured for multipay tokens.

payment.cardTransaction.vaultedCard.first6

First six digits of the card number

payment.cardTransaction.vaultedCard.last4

Last four digits of the card number

payment.cardTransaction.vaultedCard.cardholderName

Full name of the cardholder

payment.cardTransaction.vaultedCard.expirationDate

A four-digit representation of the expiration date in MMYY format

payment.cardTransaction.vaultedCard.token

A reusable, tokenized representation of the card

payment.attributes

Additional information about the payment

payment.taxRates

An array of the tax rates applied to the payment

payment.lineItemPayments

Line items (and any associated payment data) are not recorded by Clover for orders created with a Remote Pay SDK

payment.transactionSettings

An object containing the configuration of the Per-transaction settings and other merchant settings received by the device as part of the payment request.

payment.transactionSettings.cardEntryMethods

A numeric representation of the entry types allowed for the transaction:

  • `34567` — default (swipe/chip/contactless)
  • `36623` — all
  • `34824` — manual entry
  • `33025` — swipe
  • `33282` — chip
  • `33796` — contactless
  • `35081` — manual/swipe
  • `35338` — manual/chip
  • `35852` — manual/contactless
  • `33539` — swipe/chip
  • `34053` — swipe/contactless
  • `34310` — chip/contactless
  • `35595` — manual/swipe/chip
  • `36109` — manual/swipe/contactless
  • `36366` — manual/chip/contactless

payment.transactionSettings.disableCashBack

If true, the customer was not given the option to receive cash back from the transaction

payment.transactionSettings.cloverShouldHandleReceipts

If true, Clover issued a receipt based on the customer's selection on the screen

payment.transactionSettings.forcePinEntryOnSwipe

If true, the customer was required to enter their PIN if they swiped a card to pay

payment.transactionSettings.disableRestartTransactionOnFailure

If true, the device will not prompt the customer to retry a failed payment

payment.transactionSettings.allowOfflinePayment

If true, the device would process the transaction without a network connection

payment.transactionSettings.approveOfflinePaymentWithoutPrompt

If true and an offline payment occurred, the offline payment challenge was not shown to the merchant

payment.transactionSettings.forceOfflinePayment

If true, the transaction was processed without sending payment information to the payment gateway. During settlement, the payment may be rejected for insufficient funds or another reason.

payment.transactionSettings.signatureThreshold

Number of cents below which the customer is not required to sign

payment.transactionSettings.signatureEntryLocation

Where the customer provided their signature (if one was required for the payment). Possible values are ON_SCREEN, ON_PAPER, and NONE.

payment.transactionSettings.tipMode

Specifies when in the payment flow the customer was given the opportunity to add a tip. Possible values are TIP_PROVIDED , ON_SCREEN_BEFORE_PAYMENT, ON_SCREEN_AFTER_PAYMENT , and NO_TIP.

payment.transactionSettings.tippableAmount

Number of cents used to calculate percentage-based tips

payment.transactionSettings.disableReceiptSelection

If true, the receipt options screen was not shown to the customer

payment.transactionSettings.disableDuplicateCheck

If true, the device did not check whether the current payment may be a duplicate of an existing payment

payment.transactionSettings.autoAcceptPaymentConfirmations

If true, the merchant was not prompted to confirm any offline or duplicate payment challenges

payment.transactionSettings.autoAcceptSignature

If true, the merchant was not prompted to check and confirm the cardholder's signature entry

payment.transactionSettings.returnResultOnTransactionComplete

If true, the device finishes the payment flow as soon as the transaction is finalized (Germany only)

payment.transactionSettings.tipSuggestions

An array of up to four tip suggestions shown to the customer on the tip screen

payment.transactionInfo.isTokenBasedTx

If true, the transaction was processed using a vaulted customer card

payment.transactionInfo.emergencyFlag

If true, the transaction was performed in emergency mode

payment.externalReferenceId

A unique identifier sent by your POS with the transaction request. This field can be used to associate a Clover transaction with the merchant's order identifier (such as an invoice or purchase order number).

payment.isSale

If true, the transaction was processed as a sale

payment.isPreAuth

If true, the transaction was processed as a pre-auth

payment.isAuth

If true, the transaction was processed as an auth


Did this page help you?