Capture an Order

Plugin icon

Capture an Order

Only for pay-on-ship/DFC merchants. This captures funds to reflect a fulfilled item in an order. Required fields are:

  • orderId - Zip order ID to capture
  • merchantId - Your identifier provided by Zip
  • currency - The currency to issue the capture in
  • amount- The amount of the capture (not the amount of the order!)
  • merchantReference - An identifier in your system to reference this capture transaction
  • callbackUrl - A URL that will receive the webhook request about the result of this operation
  • singleCapture - True if this will be the only capture for the order and you want the rest to automatically be voided.


Request URL:
POST Body:

  "orderId": "11111111-1111-1111-1111-111111111111",
  "currency": "USD",
  "amount": 123.45,
  "merchantReference": "ref",
  "callbackUrl": "",
  "singleCapture": false