Capture amount by order
Use this endpoint to capture an amount by order. An example use-case is when an order is broken into multiple shipments, and prior to the shipment you need to capture part of the funds.
Endpoint
POST https://gateway.sezzle.com/v2/order/{order_uuid}/capture
Properties
Header Parameters
Use this header to enforce idempotency when capturing an authorization.
Parameter | Type | Description |
---|---|---|
Sezzle-Request-Id | string | A unique, merchant-generated ID. |
Capture Order Object
Parameter | Required | Type | Description |
---|---|---|---|
capture_amount | true | object | A price object with the amount and currency being captured |
Price Object
Parameter | Required | Type | Description |
---|---|---|---|
amount_in_cents | true | number | The amount in cents to release on this order |
currency | true | string | The 3 character currency code as defined by ISO 4217 |
Examples
Request
{
"capture_amount": {
"amount_in_cents": 5000,
"currency": "USD"
}
}
Response
{
"uuid": "6c9db5d4-d09a-4224-860a-b5438ac32ca8"
}
The uuid returned from this operation is the capture transaction uuid, but there are no endpoints that use this value. You may retrieve an order's capture transactions using the Get an order endpoint.