Capture a pre-authorisation

Takes money that a pre-authorisation holds on the customer's card. You can capture once, for all of the hold or part of it. Capture within 7 days of the pre-authorisation.

  • Applies to: a successful pa (pre-authorisation) on an order created with pa_only: true, with some of the hold still to capture.
  • Partial capture: send an amount lower than the hold. Only one capture is allowed per pre-authorisation, so capture the amount you need in one call.
  • Reversed holds: a reversed pa can't be captured. The gateway declines the request.
  • Declined: if the gateway declines the capture, it's still saved as a new cp payment, with successful: false.
  • 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