Capture payment

Captures a payment that is on hold, so the money is actually taken from the customer's card.

A payment is put on hold when its payment link was created with hold_and_charge_later: true. Capture it for its full amount or for less: amount must be greater than 0 and no more than the held amount.

The response is the updated Payment object. If the payment is not on hold (for example it was already captured or reversed), the call returns 422 with Charge status is not on hold.

To release the hold without charging the customer, use Reverse payment.

Recipes
🔒
Hold a payment, capture it later, and refund
Open Recipe
🏪
Run a marketplace: collect, hold, split and pay sellers
Open Recipe
Path Params
string
required
Defaults to PAY-1A2B3C4D5E

Payment ID

Body Params
number
required

Amount to be captured. Must be less than or equal to the payment's amount.

Headers
string

A unique key, such as a UUID, that makes it safe to retry this request. Reuse the same key when you retry. See Idempotency.

Responses

400

Bad Request

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

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