SchemaPaymentsRefunds

Retrieve refund

Retrieve a specific refund.

Path parameters

refundIdstringRequired=10 characters

Unique identifier that our gateway assigned to the refund.

Headers

AuthorizationstringRequired

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

Response

Successful request. Returns the specific 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 information about the card.

transactionResultobject

Object that contains information about the transaction response details.

operatorstringOptional>=0 characters<=50 characters

Operator who requested the refund.

customerobjectOptional

Customer contact and address details.

paymentobjectOptional

Object that contains information about a payment.

supportedOperationslist of enumsOptional

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 objectsOptional

Array of customField objects.