Capture an authorized order of one of your sub-merchants. An order can be captured multiple times up to the full authorized amount. Each capture creates an invoice owned by the sub-merchant, which then follows the regular invoice lifecycle and is available through the Invoices endpoints. When capturing the full amount of an order that already has line_items, neither line_items nor merchant_invoice_url is needed.
Fields for capturing an authorized order.
Amount to capture in USD. Must not exceed the remaining authorized amount.
Unique key to ensure idempotent capture requests. Repeating a request with the same key and payload returns the original result.
Number of the invoice created by this capture, for example the sub-merchant's invoice number.
URL of the sub-merchant's invoice PDF. Provide either this or line_items, not both.
- Mock serverhttps://docs.resolvepay.com/_mock/partners-api/openapi/orders/{order_id}/capture
- Sandbox serverhttps://app-sandbox.resolvepay.com/api/orders/{order_id}/capture
Captures the whole authorized amount of an order that already has line items, so no line items or invoice PDF are needed. number becomes the invoice number.
curl -i -X POST \
'https://docs.resolvepay.com/_mock/partners-api/openapi/orders/{order_id}/capture' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1000,
"idempotency_key": "capture-2024-001",
"number": "INV-100001"
}'An object representing an order.
ID of the checkout session that produced this order when a buyer authorized it through the sub-merchant's Checkout SDK. null for orders created through the API.
Whether the order is placed on net terms against the customer's credit line.
Channel that created the order, for example checkout for Checkout SDK orders or api for orders created through the API.
Current status of the order.
Remaining authorized amount available for capture in USD.
Timestamp of the first capture event.
Timestamp when the order was last updated.
{ "id": "ORDlaE5wbg0", "merchant_id": "MER456789", "checkout_id": "CHKabc123", "number": "ord_100001", "po_number": "PO-555", "advance_requested": true, "source": "checkout", "status": "authorized", "amount_authorized": 1000, "amount_captured": 500, "amount_canceled": 0, "amount_remaining": 500, "first_captured_at": "2024-01-15T10:00:00.000Z", "line_items": [ { … } ], "authorization_expires_at": "2024-02-15T10:00:00.000Z", "authorization_expiry_source": "system", "authorized_at": "2024-01-01T00:00:00.000Z", "updated_at": "2024-01-15T10:00:00.000Z", "customer": { "id": "X50sgfRd", "name": "Acme Corp", "remaining_credit": 5000 }, "capture_events": [ { … } ] }