SchemaCard PaymentsRefunds

Adjust refund

View as MarkdownOpen in Claude
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](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) method or the [Create Refund](https://docs.payroc.com/api/schema/card-payments/refunds/create-unreferenced-refund) method. **Note:** If you don’t have the refundId, use our [List Refunds](https://docs.payroc.com/api/schema/card-payments/refunds/list) 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.

Authentication

AuthorizationBearer

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

Path parameters

refundIdstringRequired=10 characters
Unique identifier that our gateway assigned to the refund.

Headers

Idempotency-KeystringRequiredformat: "uuid"
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).

Request

This endpoint expects an object.
adjustmentslist of objectsRequired

Array of polymorphic objects that contain information about adjustments to the refund.

The value of the type parameter determines which variant you should use:

  • status - Status of the transaction.
  • customer - Customer’s contact information and shipping address.
operatorstringOptional0-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.
processingTerminalIdstring4-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.
operatorstring0-50 characters
Operator who requested the refund.
customerobject
Object that contains the customer's contact details and address information.
paymentobject
Object that contains information about a payment.
supportedOperationslist of enums

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.
customFieldslist of objects
Array of customField objects.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
500
Internal Server Error