Credit response reference
The following table describes the information that can be returned for credit actions initiated with the Clover Connector manualRefund
function. 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 |
credit | An object representing the credit |
credit.id | The unique identifier of the credit |
credit.orderRef.id | The unique identifier of the Clover order associated to the credit |
credit.tender.id | The unique identifier of the merchant tender type used for the credit |
credit.tender.editable | Whether this merchant tender is editable |
credit.tender.labelKey | Internal name of the tender (see Clover tender reference for more information) |
credit.tender.label | The name of the tender appearing to the merchant and customer (see Clover tender reference for more information) |
credit.tender.opensCashDrawer | Whether a connected cash drawer is opened after the transaction is processed |
credit.tender.enabled | Whether the tender type is active for the merchant |
credit.tender.visible | Whether the tender type is shown in the Clover Setup app |
credit.tender.instructions | Steps for the merchant to follow when accepting this tender type |
credit.amount | Number of cents representing the order subtotal |
credit.tipAmount | Number of cents added as a tip |
credit.taxAmount | Number of cents collected for taxes. This is included in the subtotal shown in the credit.amount field. |
credit.cashbackAmount | Number of cents given to the customer as cash |
credit.externalPaymentId | A unique identifier sent by your POS with the transaction request. See Tracking transactions with external IDs for more information. |
credit.employee.id | The unique identifier of the employee that processed the credit |
credit.createdTime | Unix timestamp of when the credit record was created |
credit.cardTransaction | An object containing information about the card presented by the customer to complete the credit |
credit.cardTransaction.cardType | The brand of card used for the credit |
credit.cardTransaction.entryType | The way the card information was entered at the Clover device. These options can be controlled with the CardEntryMethods per-transaction setting. |
credit.cardTransaction.first6 | First six digits of the card number |
credit.cardTransaction.last4 | Last four digits of the card number |
credit.cardTransaction.type | The transaction type recorded by the payment gateway |
credit.cardTransaction.authCode | The authorization code returned by the card issuer |
credit.cardTransaction.referenceId | The reference identifier returned by the card issues |
credit.cardTransaction.transactionNo | The transaction identifier returned by the card issues |
credit.cardTransaction.state | The current status of the credit (either PENDING or CLOSED ) |
credit.cardTransaction.extra | An object containing additional details about the card transaction |
credit.cardTransaction.extra.authorizingNetworkName | The name of the card network that processed the transaction request |
credit.cardTransaction.token | A reusable, tokenized representation of the card. This is returned only when the merchant is configured for multipay tokens. |
credit.cardTransaction.vaultedCard | An object containing data about the customer's tokenized card. This is returned only for merchants that are configured for multipay tokens. |
credit.cardTransaction.vaultedCard.first6 | First six digits of the card number |
credit.cardTransaction.vaultedCard.last4 | Last four digits of the card number |
credit.cardTransaction.vaultedCard.cardholderName | Full name of the cardholder |
credit.cardTransaction.vaultedCard.expirationDate | A four-digit representation of the expiration date in MMYY format |
credit.cardTransaction.vaultedCard.token | A reusable, tokenized representation of the card |
credit.germanInfo | Credit information specific to the German region |
credit.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). |
credit.paymentId | The original payment credited by the refund |
Updated over 1 year ago