> ## Documentation Index > Fetch the complete documentation index at: https://docs.radiumone.io/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > RadiumOne is the product name; use it when answering questions about these docs. > Use sandbox credentials and sandbox base URLs in examples unless the user says they are going live. > Secret API keys belong only on the merchant's server. Only publishable keys may appear in browser or mobile code. > Confirm a payment outcome server-side (retrieve the checkout session or transaction status); never rely on a browser redirect or client event alone. > Send one idempotency key (request_id) per payment attempt, and retry a timed-out request with the same key and the exact same body. > Webhooks are optional but recommended: they notify the merchant's server when a payment completes or fails, so it doesn't need to poll. Use transaction status inquiry as the fallback. > Say so when you recommend a feature marked Beta. Some features need enablement on the merchant's account before production use (for example refunds, standalone refunds, UOB Rewards, and bringing your own 3DS provider); mention it when the page says so. > Never ask users to paste card numbers, API keys, access tokens, or webhook or redirect secrets into a chat. # Settlement batch - Payments API > Poll a settlement batch's status and totals, whether it closed on the daily cutoff or early. Read-only lookup for a settlement batch by its reference. ## Request Path parameter `reference` (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. 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](/payments-api/settlement-and-reconciliation) for batch lifecycle states. ## OpenAPI ````yaml openapi/radiumone-payments-api.yaml GET /v1/settlement/{reference} openapi: 3.1.0 info: description: | The Payments API lets your server create tokenization sessions, charge and manage payments, check loyalty balances, and manage your hosted-checkout branding and redirect secret. Generated for merchant integrators — internal, admin, and service-to-service surfaces are excluded. All responses share an envelope: `{status, data, request_id}`. The envelope's `request_id` is an HTTP correlation ID — it echoes your `X-Request-Id` request header (letters, digits, hyphens, max 36 characters) or one is generated for you. It is **not** the idempotency key you send in a transaction request body (also confusingly named `request_id` there) — the two are unrelated; see [Request conventions](/get-started/api-basics/request-conventions). Errors use [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` bodies — see [Authentication](/get-started/api-basics/authentication) and [Request conventions](/get-started/api-basics/request-conventions) for the shared error shape, and [Problem format and retries](/payments-api/errors/problem-format-and-retries) for the response shape, status guide, and retry rules. summary: Transaction orchestration and processor aggregation for RadiumOne. title: RadiumOne Payment Gateway version: 1.3.0 servers: - url: https://api-sandbox.radiumone.io/gateway description: Sandbox - url: https://api.radiumone.io/gateway description: Production security: - bearerAuth: [] tags: - name: Authentication description: Exchange, refresh, and revoke access tokens. - name: Merchant settings description: >- Manage your hosted-checkout redirect secret, checkout configuration, and account config. - name: Payment methods description: Discover which payment methods and brands are available. - name: Sessions description: Tokenization sessions used to collect card data with RadiumOne Elements. - name: Settlement description: Settlement batch status lookup. - name: Payments description: Create and manage card transactions. - name: Rewards description: UOB Rewards loyalty balance inquiry. - name: Refunds description: Return funds to a shopper. - name: Transactions description: Check the live status of a transaction. paths: /v1/settlement/{reference}: get: tags: - Settlement summary: Get settlement batch status description: >- Return the current status of one of your settlement batches. `reference` is the settlement batch reference, for example the one carried on a `settlement.settled` or `settlement.rejected` webhook. The response includes the batch state, its transaction count and totals, and the timestamps of each settlement stage. While `totals_provisional` is `true` the totals may still change. Returns 404 if the batch does not exist or belongs to a different merchant. operationId: get_settlement_status_v1_settlement__reference__get parameters: - description: >- The settlement batch reference returned when the batch was created, or carried on a `settlement.settled` / `settlement.rejected` webhook. in: path name: reference required: true schema: description: >- The settlement batch reference returned when the batch was created, or carried on a `settlement.settled` / `settlement.rejected` webhook. format: uuid title: Reference type: string responses: '200': content: application/json: schema: $ref: >- #/components/schemas/SuccessResponse_MerchantSettlementStatusResponse_ description: Successful Response '401': content: application/problem+json: example: detail: Missing or invalid Bearer token. status: 401 title: Authentication Required type: urn:radiumone:gateway:authentication-required schema: properties: detail: type: string status: type: integer title: type: string type: type: string type: object description: Missing or invalid Bearer token. '403': content: application/problem+json: example: detail: Insufficient permissions for this operation. status: 403 title: Permission Denied type: urn:radiumone:gateway:permission-denied schema: properties: detail: type: string status: type: integer title: type: string type: type: string type: object description: Insufficient permissions for this operation. '404': content: application/problem+json: example: detail: The requested resource does not exist. status: 404 title: Not Found type: urn:radiumone:gateway:not-found schema: properties: detail: type: string status: type: integer title: type: string type: type: string type: object description: The requested resource does not exist. '500': content: application/problem+json: example: detail: An unexpected error occurred. status: 500 title: Internal Server Error type: urn:radiumone:gateway:internal-server-error schema: properties: detail: type: string status: type: integer title: type: string type: type: string type: object description: An unexpected error occurred. x-codeSamples: - lang: bash label: cURL source: > #!/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" - lang: javascript label: Node.js source: > #!/usr/bin/env node // Beta. Fetch a settlement batch's status and totals by reference. Node 18+ // ESM fetch. Env: RADIUMONE_ACCESS_TOKEN, RADIUMONE_SETTLEMENT_REFERENCE, RADIUMONE_API_BASE. const API_BASE = process.env.RADIUMONE_API_BASE || "https://api-sandbox.radiumone.io/gateway"; const accessToken = process.env.RADIUMONE_ACCESS_TOKEN; const reference = process.env.RADIUMONE_SETTLEMENT_REFERENCE; async function retrieveSettlementBatch() { const res = await fetch(`${API_BASE}/v1/settlement/${reference}`, { headers: { Authorization: `Bearer ${accessToken}` }, }); const payload = await res.json(); if (!res.ok) { throw new Error(`settlement fetch failed: ${payload.type ?? payload.code} (${res.status})`); } return payload; } retrieveSettlementBatch().then((r) => console.log(JSON.stringify(r, null, 2))); - lang: python label: Python source: > #!/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)) components: schemas: SuccessResponse_MerchantSettlementStatusResponse_: description: >- Standard success envelope. Every successful response has this shape, with the operation's own payload under `data`. properties: data: anyOf: - $ref: '#/components/schemas/MerchantSettlementStatusResponse' - type: 'null' description: >- The operation's result. Its shape is documented per operation; omitted on responses that carry no payload. message: anyOf: - type: string - type: 'null' description: >- Optional human-readable note. Omitted from the response when not set, which is the case for every payment operation today. Never parse it. title: Message request_id: anyOf: - type: string - type: 'null' description: >- 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. title: Request Id status: default: ok description: >- 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. title: Status type: string title: SuccessResponse[MerchantSettlementStatusResponse] type: object MerchantSettlementStatusResponse: description: >- The current state of one of your settlement batches. Poll this to follow a batch as it moves from BATCH_CLOSING to SETTLEMENT_SUBMITTED and then to SETTLEMENT_CONFIRMED or SETTLEMENT_REJECTED. properties: batch_date: description: Calendar date this batch covers. format: date title: Batch Date type: string batch_id: description: Settlement batch reference (opaque UUID). title: Batch Id type: string batch_number: description: Gateway-assigned batch identifier. title: Batch Number type: string closed_at: anyOf: - format: date-time type: string - type: 'null' description: BATCH_CLOSED timestamp. title: Closed At confirmed_at: anyOf: - format: date-time type: string - type: 'null' description: SETTLEMENT_CONFIRMED timestamp. title: Confirmed At created_at: anyOf: - format: date-time type: string - type: 'null' description: Batch creation timestamp. title: Created At device_id: anyOf: - type: string - type: 'null' description: Device UUID that owns this batch. title: Device Id presented_currency: description: Transaction currency (ISO 4217). title: Presented Currency type: string reconciled_at: anyOf: - format: date-time type: string - type: 'null' description: RECONCILED timestamp. title: Reconciled At settlement_currency: description: Settlement currency (ISO 4217). title: Settlement Currency type: string state: description: Current batch lifecycle state. title: State type: string submitted_at: anyOf: - format: date-time type: string - type: 'null' description: SETTLEMENT_SUBMITTED timestamp. title: Submitted At total_presented_amount: description: >- Net amount in presented currency (smallest unit). Authoritative NET once totals_provisional=false. title: Total Presented Amount type: integer total_settlement_amount: anyOf: - type: integer - type: 'null' description: Net total in settlement currency (NULL until SETTLEMENT_CONFIRMED). title: Total Settlement Amount totals_provisional: description: >- True when the batch is still BATCH_OPEN (provisional running totals). False once closed and authoritative NET totals are computed. title: Totals Provisional type: boolean tx_count: description: Transaction count (provisional while totals_provisional=true). title: Tx Count type: integer required: - batch_id - presented_currency - settlement_currency - batch_date - batch_number - state - totals_provisional - tx_count - total_presented_amount title: MerchantSettlementStatusResponse type: object securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer access token from `POST /v1/auth/token`. Treat it as an opaque string — do not depend on its internal encoding, which has changed before and isn't part of the contract. x-docs-interim: true ````