Sign in

v1

latestOpenAPI 3.0.12026-07-24204977.5 KB
Pre-Auth

Capture a pre-authorization

Executes the held funds for a pre-authorization and creates an order. The pre-auth must be in AUTHORIZED status.

post/tokenized-payment/v1/pre-auths/{id}/capture

Path parameters

idstring required

Request body

useCashbackboolean

Whether to apply available cashback balance at capture. Defaults to true.

merchantMetadataobject

Opaque JSON blob stored verbatim and returned on read endpoints. Max 5 keys; each string value must not exceed 200 characters.

callbackUrlstring

HTTPS URL to receive order status webhook notifications. When provided, ShopBack will POST the order outcome to this URL upon capture.

Example request

{
  "useCashback": true,
  "merchantMetadata": {
    "tripId": "trip-456"
  },
  "callbackUrl": "https://merchant.example.com/webhooks/shopback"
}

Response

uuidstring required

Pre-authorization UUID.

orderUuidstring required

UUID of the settled order created by this capture.

statusstring required

Order status after capture.

orderTypestring required

Order type.

merchantRefstring required

Merchant's reference ID supplied at pre-auth creation.

merchantOrderIdstring required

Merchant's order ID.

consumerEmailstring required

Consumer's email address.

createdAtstring required

ISO 8601 creation timestamp.

failureReasonstring nullable required

null on a successful capture; error code when the payment is declined.

Example response

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "orderUuid": "7b3f1234-ab12-4321-b123-000000000001",
  "status": "APPROVED",
  "orderType": "ONLINE",
  "merchantRef": "trip-456",
  "merchantOrderId": "order-789",
  "consumerEmail": "user@example.com",
  "createdAt": "2026-04-30T10:00:00.000Z"
}