cURL
#!/usr/bin/env bash
# Beta. Fetch a settlement batch's status and totals by reference.
set -euo pipefail
API_BASE="${RADIUMONE_API_BASE:-https://api-sandbox.radiumone.io/gateway}"
: "${RADIUMONE_ACCESS_TOKEN:?set RADIUMONE_ACCESS_TOKEN to a Bearer access token with the settlement-read scope}"
: "${RADIUMONE_SETTLEMENT_REFERENCE:?set RADIUMONE_SETTLEMENT_REFERENCE to the batch reference}"
curl -sS "$API_BASE/v1/settlement/$RADIUMONE_SETTLEMENT_REFERENCE" \
-H "Authorization: Bearer $RADIUMONE_ACCESS_TOKEN"#!/usr/bin/env python3
"""Beta. Fetch a settlement batch's status and totals by reference."""
import json
import os
import requests
API_BASE = os.environ.get("RADIUMONE_API_BASE", "https://api-sandbox.radiumone.io/gateway")
def retrieve_settlement_batch() -> dict:
reference = os.environ["RADIUMONE_SETTLEMENT_REFERENCE"]
resp = requests.get(
f"{API_BASE}/v1/settlement/{reference}",
headers={"Authorization": f"Bearer {os.environ.get('RADIUMONE_ACCESS_TOKEN', '')}"},
timeout=30,
)
payload = resp.json()
if not resp.ok:
code = payload.get("type") or payload.get("code")
raise RuntimeError(f"settlement fetch failed: {code} ({resp.status_code})")
return payload
if __name__ == "__main__":
print(json.dumps(retrieve_settlement_batch(), indent=2))
{
"data": {
"batch_date": "2023-12-25",
"batch_id": "<string>",
"batch_number": "<string>",
"presented_currency": "<string>",
"presented_currency_minor_units": 123,
"settlement_currency": "<string>",
"settlement_currency_minor_units": 123,
"state": "<string>",
"total_presented_amount": 123,
"totals_provisional": true,
"tx_count": 123,
"closed_at": "2023-11-07T05:31:56Z",
"confirmed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"device_id": "<string>",
"reconciled_at": "2023-11-07T05:31:56Z",
"submitted_at": "2023-11-07T05:31:56Z",
"total_settlement_amount": 123
},
"message": "<string>",
"request_id": "<string>",
"status": "ok"
}{
"detail": "Request payload failed validation.",
"status": 400,
"title": "Validation Error",
"type": "urn:radiumone:payment-gateway:validation-error"
}{
"detail": "Missing or invalid Bearer token.",
"status": 401,
"title": "Authentication Required",
"type": "urn:radiumone:payment-gateway:authentication-required"
}{
"detail": "Insufficient permissions for this operation.",
"status": 403,
"title": "Permission Denied",
"type": "urn:radiumone:payment-gateway:permission-denied"
}{
"detail": "The requested resource does not exist.",
"status": 404,
"title": "Not Found",
"type": "urn:radiumone:payment-gateway:not-found"
}{
"detail": "An unexpected error occurred.",
"status": 500,
"title": "Internal Server Error",
"type": "urn:radiumone:payment-gateway:internal-error"
}{
"detail": "`urn:radiumone:payment-gateway:database-unavailable`: the database could not be reached or a query could not run. `retry_allowed` is true only for GET/HEAD/OPTIONS -- a mutating request may have reached a host before the failed write.",
"status": 503,
"title": "Database Unavailable",
"type": "urn:radiumone:payment-gateway:database-unavailable"
}Settlement batch - Payments API
Poll a settlement batch’s status and totals, whether it closed on the daily cutoff or early.
GET
/
v1
/
settlement
/
{reference}
cURL
#!/usr/bin/env bash
# Beta. Fetch a settlement batch's status and totals by reference.
set -euo pipefail
API_BASE="${RADIUMONE_API_BASE:-https://api-sandbox.radiumone.io/gateway}"
: "${RADIUMONE_ACCESS_TOKEN:?set RADIUMONE_ACCESS_TOKEN to a Bearer access token with the settlement-read scope}"
: "${RADIUMONE_SETTLEMENT_REFERENCE:?set RADIUMONE_SETTLEMENT_REFERENCE to the batch reference}"
curl -sS "$API_BASE/v1/settlement/$RADIUMONE_SETTLEMENT_REFERENCE" \
-H "Authorization: Bearer $RADIUMONE_ACCESS_TOKEN"#!/usr/bin/env python3
"""Beta. Fetch a settlement batch's status and totals by reference."""
import json
import os
import requests
API_BASE = os.environ.get("RADIUMONE_API_BASE", "https://api-sandbox.radiumone.io/gateway")
def retrieve_settlement_batch() -> dict:
reference = os.environ["RADIUMONE_SETTLEMENT_REFERENCE"]
resp = requests.get(
f"{API_BASE}/v1/settlement/{reference}",
headers={"Authorization": f"Bearer {os.environ.get('RADIUMONE_ACCESS_TOKEN', '')}"},
timeout=30,
)
payload = resp.json()
if not resp.ok:
code = payload.get("type") or payload.get("code")
raise RuntimeError(f"settlement fetch failed: {code} ({resp.status_code})")
return payload
if __name__ == "__main__":
print(json.dumps(retrieve_settlement_batch(), indent=2))
{
"data": {
"batch_date": "2023-12-25",
"batch_id": "<string>",
"batch_number": "<string>",
"presented_currency": "<string>",
"presented_currency_minor_units": 123,
"settlement_currency": "<string>",
"settlement_currency_minor_units": 123,
"state": "<string>",
"total_presented_amount": 123,
"totals_provisional": true,
"tx_count": 123,
"closed_at": "2023-11-07T05:31:56Z",
"confirmed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"device_id": "<string>",
"reconciled_at": "2023-11-07T05:31:56Z",
"submitted_at": "2023-11-07T05:31:56Z",
"total_settlement_amount": 123
},
"message": "<string>",
"request_id": "<string>",
"status": "ok"
}{
"detail": "Request payload failed validation.",
"status": 400,
"title": "Validation Error",
"type": "urn:radiumone:payment-gateway:validation-error"
}{
"detail": "Missing or invalid Bearer token.",
"status": 401,
"title": "Authentication Required",
"type": "urn:radiumone:payment-gateway:authentication-required"
}{
"detail": "Insufficient permissions for this operation.",
"status": 403,
"title": "Permission Denied",
"type": "urn:radiumone:payment-gateway:permission-denied"
}{
"detail": "The requested resource does not exist.",
"status": 404,
"title": "Not Found",
"type": "urn:radiumone:payment-gateway:not-found"
}{
"detail": "An unexpected error occurred.",
"status": 500,
"title": "Internal Server Error",
"type": "urn:radiumone:payment-gateway:internal-error"
}{
"detail": "`urn:radiumone:payment-gateway:database-unavailable`: the database could not be reached or a query could not run. `retry_allowed` is true only for GET/HEAD/OPTIONS -- a mutating request may have reached a host before the failed write.",
"status": 503,
"title": "Database Unavailable",
"type": "urn:radiumone:payment-gateway:database-unavailable"
}Read-only lookup for a settlement batch by its reference.
Request
Path parameterreference (batch UUID) — from a
settlement.settled / settlement.rejected webhook.
Response
totals_provisional is true while the batch is still open (totals are
running estimates) and false once closed, when total_settlement_amount
becomes authoritative. total_settlement_amount stays null until the
batch reaches a confirmed state.
Totals are integers in minor units. A batch carries two currencies, so it
states the minor units of each: total_presented_amount is in
presented_currency (scale presented_currency_minor_units), and
total_settlement_amount in settlement_currency (scale
settlement_currency_minor_units). See Currencies and
amounts.
Returns 404 — never 403 — for a batch
that doesn’t exist or belongs to a different merchant, to prevent batch-ID
enumeration.
See Settlement and reconciliation
for batch lifecycle states.Authorizations
Path Parameters
Response
Successful Response
Standard success envelope. Every successful response has this shape, with the operation's own payload under data.
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.
Last modified on October 25, 2026