SchemaPaymentsRefunds

Create refund

Use this method to create an unreferenced refund. An unreferenced refund is a refund that isn’t linked to a payment.

Note: If you have the paymentId of the payment you want to refund, use our Refund Payment method. If you use our Refund Payment method, our gateway sends the refund amount to the customer’s original payment method and links the refund to the payment.

In the request, you must provide the customer’s payment details and the refund amount.

In the response, our gateway returns information about the refund and a refundId, which you need for the following methods:

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.
channelenumRequired
Channel that the merchant used to request the refund.
Allowed values:
processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
orderobjectRequired
Object that contains information about the refund.
refundMethodobjectRequired
Object that contains information about how the merchant refunds the customer.
operatorstringOptional>=0 characters<=50 characters
Operator who initiated the request.
customerobjectOptional
Object that contains the customer's contact details and address information.
ipAddressobjectOptional
Object that contains information about the IP address of the device that sent the request.
customFieldslist of objectsOptional
Array of customField objects.

Response

Successful request. We processed the refund.
refundIdstring=10 characters
Unique identifier that our gateway assigned to the refund.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
orderobject
Object that contains information about the refund.
cardobject
Object that contains the details of the payment card.
transactionResultobject
Object that contains information about the transaction response details.
operatorstring or null>=0 characters<=50 characters
Operator who requested the refund.
customerobject or null
Object that contains the customer's contact details and address information.
paymentobject or null
Object that contains information about a payment.
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