Refund response reference

United States
Latin America

The following table describes the information that can be returned for credit actions initiated with the Clover Connector refundPayment function. This is not a comprehensive listing, and some properties are present only when certain transaction parameters are met.

successIndicates whether the operation was successful.
resultFinal result of the requested operation.
reasonAdditional information about the result.
messageDetailed information about the result.
orderIdUnique identifier of the Clover order associated with the refund.
paymentIdUnique identifier of the original payment associated with the refund.
refundObject representing the refund.
refund.idUnique identifier of the refund.
refund.device.idUnique identifier of the Clover device which processed the refund.
refund.amountRefund subtotal amount in cents.
refund.tipAmountTip amount in cents added to the original transaction.
refund.taxAmountTax collected amount in cents. This is included in the subtotal shown in the refund.amount field.
refund.externalReferenceIdUnique identifier sent by your POS with the original transaction request. Use the file to associate a Clover transaction with the merchant's order identifier, such as an invoice or purchase order number.
refund.createdTimeUnix timestamp of when the refund record was created.
refund.clientCreatedTimeUnix timestamp of when the refund record was created on the Clover device.
refund.payment.idUnique identifier of the original transaction.
refund.employee.idUnique identifier of the employee that processed the refund.
refund.voidedIf true, the refund was voided by a subsequent action.
refund.transactionInfo.isTokenBasedTxIf true, the transaction was processed using a vaulted customer card.
refund.transactionInfo.emergencyFlagIf true, the transaction was performed in emergency mode.
refund.transactionInfo.clientCardTypeBrand of card used for the refund.