/order/{orderId}/capture

post

https://api.us.zip.co/order/{orderId}/capture

Releases funds to merchants that have "partial payments" configured.

Partial Payments enable a merchant to accept payment (capture funds) on shipment or when a service has been rendered. This endpoint can release any amount of the order. If part of the order has been voided the /order/{orderId}/refund endpoint should be called.

The response includes the merchant reference and amount supplied with the request. The dateTime will reflect when the request was processed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orderId

string

required

The OrderId is the Zip identifier for an order. This is issued when creating an order and is also passed on the redirect confirmation URL as the 'token' parameter.

Body Params

amount

float

required

The amount to capture, usually the shipment amount. This cannot exceed the initial Order Amount minus previous captured funds

merchantReference

string

required

Merchant generated unique ID for this capture request used as an idempotency key. We suggest using a GUID here.

singleCapture

boolean

Defaults to false

Declares whether or not this will be the only capture against this order. If the capture amount is less than the order amount and this flag is set to true, the rest of the order will be voided automatically.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400

401401

404404

422422