Sign in
refunds

Adjust refund

Use this method to adjust a refund in an open batch.

To adjust 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.

You can adjust the following details of the refund:

  • Customer details, including shipping address and contact information.
  • Status of the refund.

Our gateway returns information about the adjusted refund, including:

  • Order details, including the refund amount and when we processed the refund.
  • Payment card details, including the masked card number, expiry date, and payment method.
  • Cardholder details, including their contact information and shipping address.

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

post/refunds/{refundId}/adjust

Path parameters

refundIdstring required

Unique identifier that our gateway assigned to the refund.

Headers

Authorizationstring required

Bearer authentication

Idempotency-Keystring uuid required

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 body

operatorstring

Operator who requested the adjustment to the refund.

Response

Successful request. We updated the refund.

refundIdstring required

Unique identifier that our gateway assigned to the refund.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

operatorstring

Operator who requested the refund.

supportedOperationsSupportedOperationsItems[]

Array of operations that you can perform on the transaction. Our gateway can return any of the following values:

Changes

No recorded changes to this endpoint across all 1 revision of this API.