Capture

Capture settles a pre-authorization and moves the reserved funds to your account. You must have a successful pre-authorization before calling this endpoint.

The capture amount must not exceed the originally authorized amount. If you omit amount, the full authorized amount is captured.

Safe retries for this POST endpoint use the Idempotency-Key header. Reuse the same key only when retrying the exact same request body. See Idempotency.

curl --request POST \
  --url https://terminal.smartretry.com/v1/payments/capture/ABC123 \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: capture-20260331-001' \
  --data '{
    "transaction_reference_id": "TX8A3F2C",
    "order_reference_id": "OR7B9E1D",
    "merchant_transaction_id": "capture-20260331-001",
    "amount": 49.99
  }'

import requests

response = requests.post(
    "https://terminal.smartretry.com/v1/payments/capture/ABC123",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Content-Type": "application/json",
        "Idempotency-Key": "capture-20260331-001"
    },
    json={
        "transaction_reference_id": "TX8A3F2C",
        "order_reference_id": "OR7B9E1D",
        "merchant_transaction_id": "capture-20260331-001",
        "amount": 49.99
    }
)

print(response.json())

const response = await fetch(
  "https://terminal.smartretry.com/v1/payments/capture/ABC123",
  {
    method: "POST",
    headers: {
      "x-api-key": "YOUR_API_KEY",
      "Content-Type": "application/json",
      "Idempotency-Key": "capture-20260331-001"
    },
    body: JSON.stringify({
      transaction_reference_id: "TX8A3F2C",
      order_reference_id: "OR7B9E1D",
      merchant_transaction_id: "capture-20260331-001",
      amount: 49.99
    })
  }
);

const data = await response.json();
console.log(data);

{
  "transaction_id": "TX9C4D1E",
  "order_id": "OR7B9E1D",
  "merchant_transaction_id": "capture-20260331-001",
  "accepted": true
}

{
  "type": "https://terminal.smartretry.com/errors/validation",
  "title": "Bad Request",
  "status": 400,
  "detail": "amount exceeds the authorized amount",
  "reason_code": "AMOUNT_EXCEEDS_AUTHORIZED"
}

Path parameters

string

required

Your terminal identifier. Exactly 6 characters.

Request body

string

required

The transaction_id returned by the original pre-authorization. Exactly 8 characters.

string

required

The order_id returned by the original pre-authorization. Exactly 8 characters.

string

Your unique identifier for this capture transaction. Must be different from the merchant_transaction_id used in the pre-authorization.

number

Amount to capture in major currency units (e.g., 49.99 for $49.99). If omitted, the full authorized amount is captured. If provided, must be less than or equal to the authorized amount.

string

Human-readable description of the capture. Maximum 500 characters.

Response

string

required

SmartRetry’s unique identifier for this capture transaction. Exactly 8 characters.

string

The order identifier, matching the order_id from the original pre-authorization.

string

The merchant_transaction_id you provided in the request, echoed back for confirmation.

string

The merchant_order_id associated with the order, when present.

boolean

required

true if the capture was accepted for processing. Poll the status endpoint using the returned transaction_id to confirm settlement.

Each pre-authorization can only be captured once. Attempting to capture an already-captured or voided pre-authorization will return a 400 error.

Overview

Payments

Recurring

Future Transactions

Path parameters

Request body

Response

​Path parameters

​Request body

​Response

Path parameters

Request body

Response