API references
Search documentation... ⌘K
Open merchant dashboard
Merchant API
All our references

Reverse payment

Reverses a previously authorized but not yet captured payment. Reversing a payment releases the temporary hold on the customer's funds. This is useful when a transaction is cancelled before it is captured, or when an authorization is no longer needed.

Only payments that are in an AUTHORIZED status can be reversed. Once a payment is successfully reversed, its status changes to REVERSED.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/reverse-payment HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
payment_id: string,
}
Returns: boolean
New to Reservepay? Read our guide on how to call endpoints to get started.
Request arguments
payment_id string

Required. The unique identifier of the payment to reverse. This is the payment_id that was returned when the payment was authorized.

Errors specific to this endpoint
NOT_FOUND

This error occurs when no payment with the provided ID exists in your merchant account. Double check that you're using the correct payment ID.

NOT_REVERSIBLE

Payment is not eligible for reversal. This can happen if the payment is not in an authorized state, the reversal window has passed, or the integration does not support reversals.

Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

Open in Markdown
CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/reverse-payment" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "payment_id": "pay_01kwbby4c702mbq2htbbwnywhd"
      }'
Learn how to run these code samples in your terminal by reading our guide.