Capture a pre-authorisation

Takes money that a pre-authorisation holds on the customer's card. You can capture all of the hold or part of it.

  • Applies to: a successful pa (pre-authorisation) that hasn't been captured or reversed, on an order created with pa_only: true.
  • Partial captures: send an amount lower than the hold. capturable_amount on the pa shows how much you can capture.
  • Afterwards: the capture is a new cp payment. Its original_reference_id is the pre-authorisation's original_id. The pa stays in the list.
  • To give money back after a capture, refund the cp payment. You can no longer reverse the pa.

To release the hold without taking any money, reverse the pre-authorisation instead.

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.

Body Params
number | null

Optional. How much to capture. Leave it out, or send null, to capture everything that's held. More than that returns 422.

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