Guides

Authorize

Reserves funds on a card without capturing them. Charge the hold later with Capture. Use this when you fulfill after checkout (e.g. shipping goods). To charge immediately, use Sale.

Request

curl '{gtw_url}/locations/{location_id}/transactions/authorize' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "5001",
    "currency_iso": "usd",
    "amount": 7,
    "orderid": "58589",
    "inv_number": "SP-INV-005",
    "card_data": { "token": "9HZ90qhiFq325454" },
    "storeCard": 1
  }'

Required: user_id, amount, and card_data (a token, or raw card fields). Set storeCard: 1 to tokenize the card for reuse.

Response — 200 OK

{
  "card_data": { "token": "VFwVLKuRZrAf1111", "cardfullname": "John Doe",
                 "expiry_information": "10/25", "last4": "1111", "card_brand": "Visa" },
  "amount_approved": 700,
  "authcode": "016150703802094",
  "currency_iso": "USD",
  "inv_number": "SP-INV-005",
  "transaction_id": "FA2711EF-9461-2654-9199-D05099F90D7C"
}

An authorization only holds funds — pass its transaction_id to Capture to collect them, or Void to release the hold. amount_approved is in cents.

→ Full field reference: Authorize (Using Token)