SchemaPayments

Reverse payment

Use this method to cancel or to partially cancel a payment in an open batch. This is also known as voiding a payment. To cancel a payment, you need its paymentId. Our gateway returned the paymentId in the response of the [Create Payment](https://docs.payroc.com/api/schema/payments/create) method. **Note:** If you don't have the paymentId, use our [List Payments](https://docs.payroc.com/api/schema/payments/list) method to search for the payment. If your request is successful, our gateway removes the payment from the merchant's open batch and no funds are taken from the cardholder's account.

Authentication

AuthorizationBearer

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

Path parameters

paymentIdstringRequired=10 characters
Unique identifier of the payment that the merchant wants to retrieve.

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.
operatorstringOptional>=0 characters<=50 characters
Operator who reversed the payment.
amountlongOptional

Amount of the payment that the merchant wants to reverse. The value is in the currency’s lowest denomination, for example, cents.
Note: If the merchant doesn’t send an amount, we reverse the total amount of the transaction.

Response

Successful request. We reversed the payment.
paymentIdstring=10 characters
Unique identifier that our gateway assigned to the transaction.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier of the terminal that initiated the transaction.
orderobject
Object that contains information about the payment.
cardobject
Object that contains the details of the payment card.
transactionResultobject
Object that contains information about the transaction response details.
operatorstring or null>=0 characters<=50 characters
Operator who initiated the request.
customerobject or null
Object that contains the customer's contact details and address information.
refundslist of objects or null
Array of refundSummary objects. Each object contains information about refunds linked to the transaction.
supportedOperationslist of enums or null
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 or null
Array of customField objects.

Errors