Reverse a pre-authorisation

Cancels a pre-authorisation and releases the whole hold on the customer's card. No money is taken.

  • Applies to: a successful pa (pre-authorisation) that hasn't been captured or reversed. Once any part is captured, refund the cp payment instead.
  • Whole hold only: you can't reverse part of a hold. Send an empty body.
  • Afterwards: the reversal is a new rv payment. Its original_reference_id is the pre-authorisation's original_id. The pa's refunded becomes true, although no money was taken. There's no separate reversed flag.
  • A reversed pre-authorisation can't be captured.

A reversal can't be undone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

string
required

ID of the payment.

Responses

Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json