Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.smartretry.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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://api.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
  }'

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

​
Path parameters

​
terminal_friendly_id
string
required
Your terminal identifier. Exactly 6 characters.

​
Request body

​
transaction_reference_id
string
required
The transaction_id returned by the original pre-authorization. Exactly 8 characters.
​
order_reference_id
string
required
The order_id returned by the original pre-authorization. Exactly 8 characters.
​
merchant_transaction_id
string
Your unique identifier for this capture transaction. Must be different from the merchant_transaction_id used in the pre-authorization.
​
amount
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.
​
description
string
Human-readable description of the capture. Maximum 500 characters.

​
Response

​
transaction_id
string
required
SmartRetry’s unique identifier for this capture transaction. Exactly 8 characters.
​
order_id
string
required
The order identifier, matching the order_id from the original pre-authorization.
​
merchant_transaction_id
string
required
The merchant_transaction_id you provided in the request, echoed back for confirmation.
​
accepted
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.