Refund response reference
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.
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 |
orderId | The unique identifier of the Clover order associated with the refund |
paymentId | The unique identifier of the original payment associated with the refund |
refund | An object representing the refund |
refund.id | The unique identifier of the refund |
refund.device.id | The unique identifier of the Clover device which processed the refund |
refund.amount | Number of cents representing the refund subtotal |
refund.tipAmount | Number of cents added as a tip to the original transaction |
refund.taxAmount | Number of cents collected for taxes. This is included in the subtotal shown in the refund.amount field. |
refund.externalReferenceId | A unique identifier sent by your POS with the original 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). |
refund.createdTime | Unix timestamp of when the refund record was created |
refund.clientCreatedTime | Unix timestamp of when the refund record was created on the Clover device |
refund.payment.id | The unique identifier of the original transaction |
refund.employee.id | The unique identifier of the employee that processed the refund |
refund.voided | If true , the refund was voided by a subsequent action |
refund.transactionInfo.isTokenBasedTx | If true , the transaction was processed using a vaulted customer card |
refund.transactionInfo.emergencyFlag | If true , the transaction was performed in emergency mode |
refund.transactionInfo.clientCardType | The brand of card used for the refund |
Updated 11 months ago