Refund payment
Refund a payment.
Path parameters
paymentId
Unique identifier that our gateway assigned to the payment.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Idempotency-Key
Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.
Request
This endpoint expects an object.
amount
Total amount of the refund. The value is in the currency's lowest denomination, for example, cents.
description
Description of the refund.
Response
Successful request. We refunded the payment.
paymentId
Unique identifier that we assigned to the payment.
processingTerminalId
Unique identifier that we assigned to the terminal.
order
Object that contains information about the transaction.
bankAccount
Object that contains information about the bank account.
transactionResult
Object that contains information about the transaction.
customer
Object that contains information about the customer.
refunds
List of refunds issued against the payment
returns
List of returns issued against the payment
representment
Object that contains information about a payment.
customFields
Array of customField objects.