Manual/Delayed Capture
Manual/delayed capture is the process of placing an authorization hold on a card, and then manually “capturing” the payment at a later date, typically at the time of fulfillment.
The initial invocation of create_payment_session requires that the customer be present in the checkout flow. Additional calls for capture or voids don’t require customer-in-flow.
Authorization holds for manual capture are created and managed using the same create_payment_session endpoint outlined in the Payments Overview.
Our manual capture product relies on partners storing the id field from the payment session response and calling /payments/v1/payment_session/{id}/capture when the payment should be captured, or /payments/v1/payment_session/{id}/void to release the authorization hold.
Flow Diagram
Request Body
Limited access: The kind field is only enabled on merchant accounts on a limited basis. Please contact your Truemed PoC to get access.
The create_payment_session endpoint can be invoked with the additional fields described here.
Kind Values
one_time_payment(DEFAULT): The charge is immediately captured. This is the default if this field is not set.authorization: Aone_time_paymentauthorization hold only. Must be manually captured or voided with a follow-up API call.
Response Body
The response is the same as described in the create_payment_session API reference, with additional error states.
Bad Request
HTTP Status: 400
If a field is missing or the request otherwise can’t be processed, we’ll return a 400.
Capture and Void Operations
Once an authorization hold has been created, you can either capture or void it:
- Capture: Call
POST /payments/v1/payment_session/{id}/captureto capture the authorized amount. - Void: Call
POST /payments/v1/payment_session/{id}/voidto release the authorization hold without capturing.
