Refund response reference

United States

Canada

Europe

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.

Property	Description
`success`	Indicates whether the operation was successful.
`result`	Final result of the requested operation.
`reason`	Additional information about the result.
`message`	Detailed information about the result.
`orderId`	Unique identifier of the Clover order associated with the refund.
`paymentId`	Unique identifier of the original payment associated with the refund.
`refund`	Object representing the refund.
`refund.id`	Unique identifier of the refund.
`refund.device.id`	Unique identifier of the Clover device which processed the refund.
`refund.amount`	Refund subtotal amount in cents.
`refund.tipAmount`	Tip amount in cents added to the original transaction.
`refund.taxAmount`	Tax collected amount in cents. This is included in the subtotal shown in the `refund.amount` field.
`refund.externalReferenceId`	Unique 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.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`	Unique identifier of the original transaction.
`refund.employee.id`	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`	Brand of card used for the refund.