SchemaPaymentsRefunds

Adjust refund

Adjust an existing 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.

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.
adjustmentslist of objectsRequired
Array of objects that contain information about the adjustments to the refund.
operatorstringOptional>=0 characters<=50 characters
Operator who requested the adjustment to the refund.

Response

Successful request. We updated 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 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.

Errors