SchemaPaymentsBank Transfer Refunds

Retrieve refund

Use this method to retrieve information about a refund.

To retrieve a refund, you need its refundId. Our gateway returned the refundId in the response of the Refund Payment method or the Create Refund method.

Note: If you don’t have the refundId, use our List Refunds method to search for the refund.

Our gateway returns the following information about the refund:

  • Order details, including the refund amount and when it was processed.
  • Bank account details, including the customer’s name and account number.

If the refund is a referenced refund, our gateway also returns details about the payment that the refund is linked to.

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 order.
bankAccountobject
Object that contains information about the bank account.
transactionResultobject
Object that contains information about the transaction.
customerobject or null
Object that contains information about the customer.
paymentobject or null
Object that contains information about a payment.
customFieldslist of objects or null
Array of customField objects.

Errors