Overview

The capture amount can be specified, but If no amount is specified, Skipify will capture 100% of authorized funds.
It is possible to process multiple captures until the full authorization amount of the order is reached. To perform a partial capture, pass a non-null amount in the request body. The amount must be less than the original authorization total.

❗️

Important

The duration of authorizations typically falls between 7 to 30 days, varying based on the payment service provider (PSP) you utilize. Please consult your PSP documentation to verify the specific expiration timelines for authorizations.

👍

This endpoint uses HMAC with SHA-256

Check out our API Authentication section to learn more

To capture an order, send an API call to:

Staging: POST https://stage-oms.skipify.com/{orderId}/capture

Production: POST https://oms.skipify.com/{orderId}/capture

Request Body Parameters

Request Body Example

{
  "amount": 5800, // $ 58.00
  "transactionId": {{skipifytransactionId}} // optional, i.e.: send the transactionId for the partial authorization tied to the overall orderId

API Response

Response Body Parameters

Response Body Example

{
  "orderId": "string",
  "merchantId": "string",
  "amount": integer,
  "transactionId": "string",
  "status": "Captured",
  "message": "string"
}