---
title: "/orders/{orderId}/capture"
method: POST
path: "/orders/{orderId}/capture"
---

# /orders/{orderId}/capture

`POST /orders/{orderId}/capture`

Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/capture

Captures funds for the specified order. Only applicable to pay-on-ship/deferred fund capture merchants. If sync query parameter is set to true, replies synchronously with callback payload, otherwise, replies asynchronously on callback URL. Default sync value is false for asynchronous behavior.

## Path parameters

- `orderId` string, required

## Query parameters

- `sync` boolean

## Headers

- `QP-Territory` string, required
- `X-QP-Signature` string, required

## Request body

- object
  - `merchantId` string, required — Gets or sets the MerchantId
  - `currency` string, required — Gets or sets the Currency of the capture
  - `amount` number, double, required — Gets or sets the Amount of the capture
  - `merchantReference` string, required — Gets or sets the Merchant Reference of the capture
  - `singleCapture` boolean — Gets or sets a value indicating whether or not the order will only be captured once. In that case if the capture value is less than the order value, the remainder will be voided.
  - `callbackUrl` string — Gets or sets the url to callback with the capture result
  - `test` boolean — Gets or sets a value indicating whether this is a test order
  - `Metadata` object — Gets or sets optional metadata associated with this capture

## Response `200`

200

- object
  - `timestamp` string
  - `merchantId` string
  - `orderId` string
  - `currency` string
  - `amount` integer
  - `merchantReference` string
  - `test` boolean
  - `success` boolean
  - `message` string
  - `metadata` object
    - `additionalProp` string
  - `operation` string

## Other responses

- `204` — 204
- `400` — 400

---

[API](https://skmtc.dev/zip/apis/gateway-api.md) · [All operations](https://skmtc.dev/zip/apis/gateway-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zip/gateway-api/revisions/4b1127fdca1e/schema)