Authorize and capture

Hold funds on a card now and collect them later, for example when an order ships.

A payment created with capture_method: "manual" is authorized but not collected. The customer’s card issuer holds the amount, and the payment stays Requires capture until you capture it or cancel it. Capturing collects the money. Canceling releases the hold, and the customer is never charged.

Authorize a payment

Create the payment with capture_method set to manual:

server.ts

const payment = await bias.payments.create({
    amount: 4800,
    customer: "cus_8fKq2LmVx7RtYw3HbN5pGY2",
    payment_method: "pm_4Zt9wQe1RyUi7OpAsDfpGY2",
    capture_method: "manual",
});

If the card is approved, the payment’s status is requires_capture and amount_capturable is the authorized amount. Bias sends payment.amount_capturable_updated.

In the dashboard, click New payment on the Payments tab, enter a card, and check Capture later.

Manual capture works with card payments only. Bank account payments and payments made through a checkout session are captured automatically.

An authorized payment for an invoice doesn’t pay the invoice. The invoice is paid once you capture the payment.

Capture a payment

Capture collects the full authorized amount:

server.ts

const payment = await bias.payments.capture("pay_5qRDCgiIwaqIOrRZRpGY2");

The payment becomes succeeded, amount_received is the captured amount, and Bias sends payment.succeeded. Only payments in requires_capture can be captured. A captured payment can only be reversed with a refund.

The card issuer can release the hold if the payment isn’t captured within 7 days of the authorization.

Cancel an authorization

Cancel a payment you won’t collect, for example when an order is called off:

server.ts

const payment = await bias.payments.cancel("pay_5qRDCgiIwaqIOrRZRpGY2");

The payment becomes canceled, the hold on the customer’s card is released, and Bias sends payment.canceled. A card payment can be canceled only while it’s in requires_capture.

In the dashboard

To find payments waiting to be captured, filter the Payments tab by the Requires capture status. Open one and click Actions:

Capture collects the full authorized amount.
Cancel releases the authorization. Confirm with Cancel payment.

To capture or cancel several payments at once, select them in the list and click Capture payments or Cancel payments.

See Payments in the API reference for the full request and response.

Authorize a payment
Capture a payment
Cancel an authorization
In the dashboard