Pass in a payment ID in order to either refund or void the payment. If the payment has not yet settled (payments generally settle at the end of every day) then the original will be voided. If it has already settled, then a refund transaction will be created for the full amount of the original payment.

Header Parameters

Parameter

Type

Description

accessId*

String

Unique identifier that ensures that the integrator has the authorization to make requests on behalf of the customer. (Specifically, a customer's merchant account)


Body Parameters

Parameter

Type

Description

token*

Object/Hash

Object containing authentication parameters - most crucially the requestId which is required with every call. For more information, see the Token Object.

paymentId

String

The payment ID of the payment being fully refunded or voided.

enableRemainingAmountRefunds

Boolean

This is used in the event that part of payment has already been refunded. If this is set to true, then the a refund will be issued for whatever is left in order to get the total amount refunded equal to the total amount of the payment. If set to false, then will respond with error message stating that the transaction has already been partially refunded.

refundNote

String

Notes will be stamped on refund and viewable on the in-app payment details page of the refund.

orderId

String

Values sent here will be stored in the Order Number field within ClientPay.

emailOptions

Object/Hash

Object containing various options for emailing a payment receipt. See the email options object for more details.

Language