SchemaPayments

Refund payment

Use this method to refund a payment that is in a closed batch.

To refund a payment, you need its paymentId. Our gateway returned the paymentId in the response of the Create Payment method.

Note: If you don’t have the paymentId, use our List Payments method to search for the payment.

If your refund is successful, our gateway returns the payment amount to the cardholder’s account.

Things to consider

  • If the merchant refunds a payment that is in an open batch, our gateway reverses the payment.
  • Some merchants can run unreferenced refunds, which means that they don’t need a paymentId to return an amount to a customer. For more information about how to run an unreferenced refund, go to Create Refund.

Path parameters

paymentIdstringRequired=10 characters
Unique identifier of the payment that the merchant wants to retrieve.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

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.
amountlongRequired

Amount of the payment that the merchant wants to refund. The value is in the currency’s lowest denomination, for example, cents.

descriptionstringRequired>=1 character<=100 characters
Reason for the refund.
operatorstringOptional>=0 characters<=50 characters
Operator who refunded the payment.

Response

Successful request. We refunded the payment.
paymentIdstring=10 characters
Unique identifier that our gateway assigned to the transaction.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier of the terminal that initiated the transaction.
orderobject
Object that contains information about the payment.
cardobject
Object that contains information about the card.
transactionResultobject
Object that contains information about the transaction response details.
operatorstring or null>=0 characters<=50 characters
Operator who initiated the request.
customerobject or null
Object that contains the customer's contact details and address information.
refundslist of objects or null
Array of refundSummary objects. Each object contains information about refunds linked to the transaction.
supportedOperationslist of enums or null

Array of operations that you can perform on the transaction.

  • capture - Capture the payment.
  • refund - Refund the payment.
  • fullyReverse - Fully reverse the transaction.
  • partiallyReverse - Partially reverse the payment.
  • incrementAuthorization - Increase the amount of the authorization.
  • adjustTip - Adjust the tip post-payment.
  • addSignature - Add a signature to the payment.
  • setAsReady - Set the transaction’s status to ready.
  • setAsPending - Set the transaction’s status to pending.
  • setAsDeclined - Set the transaction’s status to declined.
customFieldslist of objects or null
Array of customField objects.

Errors