#!/usr/bin/env bash# Authorize only (reserve funds, capture later). Any 2xx is a response — branch# on data.status. On a timeout/5xx/PENDING, retry with the SAME request_id;# never mint a new one for the same order attempt. Even after a# 5xx with retry_allowed: false, a same-request_id replay is a lookup, not a# resend -- it never charges the card again.set -euo pipefailAPI_BASE="${RADIUMONE_API_BASE:-https://api-sandbox.radiumone.io/gateway}": "${RADIUMONE_ACCESS_TOKEN:?set RADIUMONE_ACCESS_TOKEN to a Bearer access token}"curl -sS -X POST "$API_BASE/v1/transactions/auth" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $RADIUMONE_ACCESS_TOKEN" \ -d @request.json
#!/usr/bin/env python3
"""Authorize only (reserve funds, capture later). Any 2xx is a response — branch
on data.status. On a timeout/5xx/PENDING, replay the SAME request_id;
never mint a new one for the same order attempt.
Shared result pattern: any 2xx is a response you branch on 'status'. On a
network timeout, any 5xx, or status 'PENDING'/'REVERSAL_PENDING', replay the
SAME request_id -- never mint a new one for the same attempt. A same-request_id
replay is a lookup: RadiumOne returns the recorded attempt and never sends the
payment again, so it's safe even after a 5xx that says ``retry_allowed: false``
(e.g. switch-timeout). Until the outcome settles it can keep returning PENDING
or REVERSAL_PENDING -- then wait for the webhook.
"""
import json
import os
import random
import time
from pathlib import Path
import requests
API_BASE = os.environ.get("RADIUMONE_API_BASE", "https://api-sandbox.radiumone.io/gateway")
def backoff_seconds(attempt: int) -> float:
"""Exponential backoff with jitter: attempt 1 waits ~0.25-0.5s, doubling
each attempt, capped at 4s -- avoids hammering the gateway in a loop."""
base = min(0.25 * 2 ** (attempt - 1), 4.0)
return base + random.random() * base
def create_authorization(max_attempts: int = 3) -> dict:
body = json.loads((Path(__file__).parent / "request.json").read_text())
headers = {"Authorization": f"Bearer {os.environ.get('RADIUMONE_ACCESS_TOKEN', '')}"}
for attempt in range(1, max_attempts + 1):
try:
resp = requests.post(f"{API_BASE}/v1/transactions/auth", json=body, headers=headers, timeout=30)
except (requests.exceptions.Timeout, requests.exceptions.ConnectionError):
if attempt == max_attempts:
raise
time.sleep(backoff_seconds(attempt))
continue
if resp.status_code >= 500:
try:
problem = resp.json()
except ValueError:
problem = {}
# Any 5xx -- even retry_allowed: false (switch-timeout, database-unavailable):
# replaying the SAME request_id is a lookup, not a resend, so it never
# charges the card again. Out of attempts? Wait for the webhook.
if attempt == max_attempts:
raise RuntimeError(f"{problem.get('type') or 'server error'} ({resp.status_code}) after {attempt} attempts -- wait for the webhook")
time.sleep(backoff_seconds(attempt))
continue
payload = resp.json()
if not resp.ok:
code = payload.get("type") or payload.get("code")
raise RuntimeError(f"request failed: {code} ({resp.status_code})")
if payload["data"]["status"] in ("PENDING", "REVERSAL_PENDING"):
if attempt == max_attempts:
return payload
time.sleep(backoff_seconds(attempt))
continue
return payload # branch on data.status
raise RuntimeError("unreachable")
if __name__ == "__main__":
print(json.dumps(create_authorization(), indent=2))
{
"detail": "Missing or invalid Bearer token, or `urn:radiumone:payment-gateway:authentication-required` because your merchant account is not active (suspended, disabled or deleted). Checked on every request, not only when the token is issued.",
"status": 401,
"title": "Authentication Required",
"type": "urn:radiumone:payment-gateway:authentication-required"
}
{
"detail": "Insufficient permissions for this operation; `urn:radiumone:payment-gateway:auth:outlet-binding-violation`: the request's `outlet_id` names a different outlet than the one your API key is bound to; or `urn:radiumone:payment-gateway:merchant:outlet-disabled` (`retry_allowed: false`): the outlet -- the one named, the one your key is bound to, or your DEFAULT outlet -- is disabled. Re-enabling the outlet restores service; the key is not revoked.",
"status": 403,
"title": "Permission Denied",
"type": "urn:radiumone:payment-gateway:auth:outlet-binding-violation"
}
{
"detail": "The requested resource does not exist, or `urn:radiumone:payment-gateway:checkout:outlet-not-found`: the outlet (named, key-bound, or your DEFAULT outlet) does not exist for your account. One answer on every surface (was 400 `payment-gateway:validation-error` on transactions).",
"status": 404,
"title": "Not Found",
"type": "urn:radiumone:payment-gateway:checkout:outlet-not-found"
}
{
"detail": "The terminal-unavailable family (`device-settling`, `device-busy` (a usable terminal is locked by a concurrent operation; `retry_allowed: true`, retry with the same `request_id`), `device-batch-rejected`, `terminal-inactive`, `operation-disabled`, `no-device-available`, `device-unpaired`, `payment-gateway:loyalty:device-not-validated`, `raw-card-not-permitted` (the request sent `card.pan` and no terminal that could serve it is enabled for raw card data -- send a payment token, or ask RadiumOne to enable it; `retry_allowed: false`); each with a `resolution` member), `payment-gateway:transaction:void-reversal-pending`, or an idempotency conflict. A sale that redeems loyalty value is refused with the loyalty terminal's own 409 BEFORE the card is charged. Also `urn:radiumone:payment-gateway:routing:channel-disabled` (`retry_allowed: false`): the outlet's channel for this request is disabled.",
"status": 409,
"title": "Conflict",
"type": "urn:radiumone:payment-gateway:routing:channel-disabled"
}
{
"detail": "The payment token has expired or its card data is no longer available.",
"status": 410,
"title": "Gone",
"type": "urn:radiumone:payment-gateway:token:data-purged"
}
{
"detail": "The request cannot be processed as sent. On a sale that redeems loyalty value, checked before anything is charged: `urn:radiumone:payment-gateway:transaction:loyalty-leg-required` (no loyalty program can serve the redemption for this outlet, channel and currency) or `urn:radiumone:payment-gateway:routing:capability-not-supported` (the loyalty program does not accept the redemption on this channel). Both are configuration outcomes: a retry does not help. The routing refusals `urn:radiumone:payment-gateway:routing:rule-rejected` and `urn:radiumone:payment-gateway:routing:no-rule-match` carry `reason` (`card`: this card cannot be used here, another may be; `transaction`: the request cannot be routed whatever the card) and `retry_allowed: false`. Currency: `urn:radiumone:payment-gateway:currency:unknown-currency` (the currency is well-formed but not an active ISO 4217 currency -- an unknown, fund, N.A. or withdrawn code; `errors[]` names the field, `retry_allowed: false`) or `urn:radiumone:payment-gateway:currency:minor-units-not-supported` (a valid ISO 4217 currency whose minor units are not 2, e.g. JPY or KWD -- only 2-decimal currencies are supported; `retry_allowed: false`).",
"status": 422,
"title": "Unprocessable Content",
"type": "urn:radiumone:payment-gateway:transaction:loyalty-leg-required"
}
{
"detail": "A downstream dependency is unavailable or did not respond in time -- the `retry_allowed` extension says whether a retry is safe. Also `urn:radiumone:payment-gateway:routing:no-device` (no usable terminal when the transaction was attempted; `resolution: operator`, `retry_allowed: false`), `urn:radiumone:payment-gateway:routing:device-resolution-failed` (a gateway fault while selecting a terminal; `retry_allowed: false`), `urn:radiumone:payment-gateway:routing:acquirer-circuit-open` (every acquirer that could serve the request is temporarily unavailable; `retry_allowed: true`, `resolution: transient`), and -- on a sale that redeems loyalty value -- `urn:radiumone:payment-gateway:routing:loyalty-mode-unavailable` (the loyalty program could not be resolved; `retry_allowed: true`, `resolution: transient`). Nothing was charged or redeemed for any of them. `urn:radiumone:payment-gateway:service-unavailable` carries `retry_allowed` true when the failure came before any work (signing keys unavailable, service starting). `urn:radiumone:payment-gateway:request-deadline-exceeded` carries `retry_allowed` true only for GET/HEAD/OPTIONS -- a mutating request may have reached a host.",
"status": 503,
"title": "Service Unavailable",
"type": "urn:radiumone:payment-gateway:routing:no-device"
}
Authorize - Payments API
Authorize a card payment to hold funds without capturing them, then capture it later, or let it lapse. A duplicate request ID returns the original response.
POST
/
v1
/
transactions
/
auth
cURL
#!/usr/bin/env bash# Authorize only (reserve funds, capture later). Any 2xx is a response — branch# on data.status. On a timeout/5xx/PENDING, retry with the SAME request_id;# never mint a new one for the same order attempt. Even after a# 5xx with retry_allowed: false, a same-request_id replay is a lookup, not a# resend -- it never charges the card again.set -euo pipefailAPI_BASE="${RADIUMONE_API_BASE:-https://api-sandbox.radiumone.io/gateway}": "${RADIUMONE_ACCESS_TOKEN:?set RADIUMONE_ACCESS_TOKEN to a Bearer access token}"curl -sS -X POST "$API_BASE/v1/transactions/auth" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $RADIUMONE_ACCESS_TOKEN" \ -d @request.json
#!/usr/bin/env python3
"""Authorize only (reserve funds, capture later). Any 2xx is a response — branch
on data.status. On a timeout/5xx/PENDING, replay the SAME request_id;
never mint a new one for the same order attempt.
Shared result pattern: any 2xx is a response you branch on 'status'. On a
network timeout, any 5xx, or status 'PENDING'/'REVERSAL_PENDING', replay the
SAME request_id -- never mint a new one for the same attempt. A same-request_id
replay is a lookup: RadiumOne returns the recorded attempt and never sends the
payment again, so it's safe even after a 5xx that says ``retry_allowed: false``
(e.g. switch-timeout). Until the outcome settles it can keep returning PENDING
or REVERSAL_PENDING -- then wait for the webhook.
"""
import json
import os
import random
import time
from pathlib import Path
import requests
API_BASE = os.environ.get("RADIUMONE_API_BASE", "https://api-sandbox.radiumone.io/gateway")
def backoff_seconds(attempt: int) -> float:
"""Exponential backoff with jitter: attempt 1 waits ~0.25-0.5s, doubling
each attempt, capped at 4s -- avoids hammering the gateway in a loop."""
base = min(0.25 * 2 ** (attempt - 1), 4.0)
return base + random.random() * base
def create_authorization(max_attempts: int = 3) -> dict:
body = json.loads((Path(__file__).parent / "request.json").read_text())
headers = {"Authorization": f"Bearer {os.environ.get('RADIUMONE_ACCESS_TOKEN', '')}"}
for attempt in range(1, max_attempts + 1):
try:
resp = requests.post(f"{API_BASE}/v1/transactions/auth", json=body, headers=headers, timeout=30)
except (requests.exceptions.Timeout, requests.exceptions.ConnectionError):
if attempt == max_attempts:
raise
time.sleep(backoff_seconds(attempt))
continue
if resp.status_code >= 500:
try:
problem = resp.json()
except ValueError:
problem = {}
# Any 5xx -- even retry_allowed: false (switch-timeout, database-unavailable):
# replaying the SAME request_id is a lookup, not a resend, so it never
# charges the card again. Out of attempts? Wait for the webhook.
if attempt == max_attempts:
raise RuntimeError(f"{problem.get('type') or 'server error'} ({resp.status_code}) after {attempt} attempts -- wait for the webhook")
time.sleep(backoff_seconds(attempt))
continue
payload = resp.json()
if not resp.ok:
code = payload.get("type") or payload.get("code")
raise RuntimeError(f"request failed: {code} ({resp.status_code})")
if payload["data"]["status"] in ("PENDING", "REVERSAL_PENDING"):
if attempt == max_attempts:
return payload
time.sleep(backoff_seconds(attempt))
continue
return payload # branch on data.status
raise RuntimeError("unreachable")
if __name__ == "__main__":
print(json.dumps(create_authorization(), indent=2))
{
"detail": "Missing or invalid Bearer token, or `urn:radiumone:payment-gateway:authentication-required` because your merchant account is not active (suspended, disabled or deleted). Checked on every request, not only when the token is issued.",
"status": 401,
"title": "Authentication Required",
"type": "urn:radiumone:payment-gateway:authentication-required"
}
{
"detail": "Insufficient permissions for this operation; `urn:radiumone:payment-gateway:auth:outlet-binding-violation`: the request's `outlet_id` names a different outlet than the one your API key is bound to; or `urn:radiumone:payment-gateway:merchant:outlet-disabled` (`retry_allowed: false`): the outlet -- the one named, the one your key is bound to, or your DEFAULT outlet -- is disabled. Re-enabling the outlet restores service; the key is not revoked.",
"status": 403,
"title": "Permission Denied",
"type": "urn:radiumone:payment-gateway:auth:outlet-binding-violation"
}
{
"detail": "The requested resource does not exist, or `urn:radiumone:payment-gateway:checkout:outlet-not-found`: the outlet (named, key-bound, or your DEFAULT outlet) does not exist for your account. One answer on every surface (was 400 `payment-gateway:validation-error` on transactions).",
"status": 404,
"title": "Not Found",
"type": "urn:radiumone:payment-gateway:checkout:outlet-not-found"
}
{
"detail": "The terminal-unavailable family (`device-settling`, `device-busy` (a usable terminal is locked by a concurrent operation; `retry_allowed: true`, retry with the same `request_id`), `device-batch-rejected`, `terminal-inactive`, `operation-disabled`, `no-device-available`, `device-unpaired`, `payment-gateway:loyalty:device-not-validated`, `raw-card-not-permitted` (the request sent `card.pan` and no terminal that could serve it is enabled for raw card data -- send a payment token, or ask RadiumOne to enable it; `retry_allowed: false`); each with a `resolution` member), `payment-gateway:transaction:void-reversal-pending`, or an idempotency conflict. A sale that redeems loyalty value is refused with the loyalty terminal's own 409 BEFORE the card is charged. Also `urn:radiumone:payment-gateway:routing:channel-disabled` (`retry_allowed: false`): the outlet's channel for this request is disabled.",
"status": 409,
"title": "Conflict",
"type": "urn:radiumone:payment-gateway:routing:channel-disabled"
}
{
"detail": "The payment token has expired or its card data is no longer available.",
"status": 410,
"title": "Gone",
"type": "urn:radiumone:payment-gateway:token:data-purged"
}
{
"detail": "The request cannot be processed as sent. On a sale that redeems loyalty value, checked before anything is charged: `urn:radiumone:payment-gateway:transaction:loyalty-leg-required` (no loyalty program can serve the redemption for this outlet, channel and currency) or `urn:radiumone:payment-gateway:routing:capability-not-supported` (the loyalty program does not accept the redemption on this channel). Both are configuration outcomes: a retry does not help. The routing refusals `urn:radiumone:payment-gateway:routing:rule-rejected` and `urn:radiumone:payment-gateway:routing:no-rule-match` carry `reason` (`card`: this card cannot be used here, another may be; `transaction`: the request cannot be routed whatever the card) and `retry_allowed: false`. Currency: `urn:radiumone:payment-gateway:currency:unknown-currency` (the currency is well-formed but not an active ISO 4217 currency -- an unknown, fund, N.A. or withdrawn code; `errors[]` names the field, `retry_allowed: false`) or `urn:radiumone:payment-gateway:currency:minor-units-not-supported` (a valid ISO 4217 currency whose minor units are not 2, e.g. JPY or KWD -- only 2-decimal currencies are supported; `retry_allowed: false`).",
"status": 422,
"title": "Unprocessable Content",
"type": "urn:radiumone:payment-gateway:transaction:loyalty-leg-required"
}
{
"detail": "A downstream dependency is unavailable or did not respond in time -- the `retry_allowed` extension says whether a retry is safe. Also `urn:radiumone:payment-gateway:routing:no-device` (no usable terminal when the transaction was attempted; `resolution: operator`, `retry_allowed: false`), `urn:radiumone:payment-gateway:routing:device-resolution-failed` (a gateway fault while selecting a terminal; `retry_allowed: false`), `urn:radiumone:payment-gateway:routing:acquirer-circuit-open` (every acquirer that could serve the request is temporarily unavailable; `retry_allowed: true`, `resolution: transient`), and -- on a sale that redeems loyalty value -- `urn:radiumone:payment-gateway:routing:loyalty-mode-unavailable` (the loyalty program could not be resolved; `retry_allowed: true`, `resolution: transient`). Nothing was charged or redeemed for any of them. `urn:radiumone:payment-gateway:service-unavailable` carries `retry_allowed` true when the failure came before any work (signing keys unavailable, service starting). `urn:radiumone:payment-gateway:request-deadline-exceeded` carries `retry_allowed` true only for GET/HEAD/OPTIONS -- a mutating request may have reached a host.",
"status": 503,
"title": "Service Unavailable",
"type": "urn:radiumone:payment-gateway:routing:no-device"
}
Authorizations
Authorization
string
header
required
Access token from POST /v1/auth/token, sent as Authorization: Bearer <token>. Treat it as opaque.
Body
application/json
Request body for POST /v1/transactions/auth.
Authorise-only: reserves funds without capturing. Use CAPTURE to complete.
Idempotent via request_id scoped to the authenticated merchant.
amount
MoneyAmount · object
required
Amount to authorize, as a {currency, value} money object.
Show child attributes
card
PaymentCard · object
required
The card: its payment token (preferred), or pan + expiry (+ cvv) when the terminal is enabled for raw card data. Send exactly one of the two forms.
Transaction channel -- the source/manner of the payment. Shapes routing candidate selection and the capability/operation constraints applied downstream (acquirer_channel + acquirer_channel_operation gating).
Available options:
CARD_PRESENT,
ECOMMERCE,
MOTO,
PAYMENT_LINK,
IN_APP,
RECURRING
request_id
string
required
Merchant-supplied idempotency key.
Required string length: 8 - 64
emv
stringEmv · object
EMV chip data read from the card, for card-present authorizations. Send it either as the hex string your terminal produced or as a map of EMV tag to hex value. Omit it for online payments made with a token.
metadata
Metadata · object | null
Optional merchant-supplied metadata.
order_reference
string | null
Merchant's order/cart reference for this authorization (common in ecommerce). Stored, searchable via the transaction list filter, and forwarded to the acquirer for reconciliation. Capture/void/refund inherit it from this transaction, so one acquirer-side lookup returns the whole order. Acquirers impose their own limits and character rules (commonly 20 characters, alphanumeric) and will shorten the value to fit, so prefer short references using letters, digits, '-', '.' and '_', and put the varying part LAST -- values are shortened from the front.
Maximum string length: 128
outlet_id
string<uuid> | null
Outlet to transact on. Omit it to use the outlet your API key is bound to, or your DEFAULT outlet when the key is not bound. Sending the outlet your checkout session was created for makes the sale route exactly as that session's payment methods were discovered. A key bound to a different outlet is refused with 403 urn:radiumone:payment-gateway:auth:outlet-binding-violation. Part of the idempotency key only when sent: a retry of the same request_id naming a different outlet is refused with 409.
selected_payment_method
string | null
Recommended -- it will become required. The payment method your shopper chose: one of the payment_methods[].type values returned for the checkout session (card for an ordinary card sale, including instalments; uob_irr for a sale that redeems loyalty rewards). Once it is required, omitting it returns 422 urn:radiumone:payment-gateway:checkout:payment-method-required, except on an idempotent replay of a request originally accepted without it. When sent, a method not offered here returns 422 urn:radiumone:payment-gateway:checkout:payment-method-not-offered (reason: not_offered or unknown). Part of the idempotency key only when sent. Not echoed on the response.
Maximum string length: 32
three_ds
ThreeDsPurchaseInput · object | null
3DS result (one of {ref} | {mode:unauthenticated} | {cavv,...}); absent == unauthenticated.
Show child attributes
Response
Successful Response
Standard success envelope. Every successful response has this shape, with the operation's own payload under data.
data
TransactionResponse · object | null
The operation's result. Its shape is documented per operation; omitted on responses that carry no payload.
Show child attributes
message
string | null
Optional human-readable note. Omitted from the response when not set, which is the case for every payment operation today. Never parse it.
request_id
string | null
Correlation ID for this HTTP request, for logs and support. Send your own in the X-Request-Id header (letters, digits and hyphens, up to 36 characters -- other characters are stripped) or the gateway generates one. This is NOT the request_id idempotency key you send in a transaction body; the two are unrelated.
status
string
default:ok
Always ok on a successful (2xx) response. Errors use a different body shape entirely (RFC 9457 problem details), so branch on the HTTP status code, not on this field.