cURL
#!/usr/bin/env bash
# Retrieve your resolved hosted-checkout settings, as the Checkout API front
# end consumes them.
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 (secret key)}"
curl -sS "$API_BASE/v1/merchant/checkout" \
-H "Authorization: Bearer $RADIUMONE_ACCESS_TOKEN"#!/usr/bin/env python3
"""Retrieve your resolved hosted-checkout settings."""
import json
import os
import requests
API_BASE = os.environ.get("RADIUMONE_API_BASE", "https://api-sandbox.radiumone.io/gateway")
def get_merchant_checkout_settings() -> dict:
resp = requests.get(
f"{API_BASE}/v1/merchant/checkout",
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"merchant/checkout failed: {code} ({resp.status_code})")
return payload
if __name__ == "__main__":
print(json.dumps(get_merchant_checkout_settings(), indent=2))
{
"data": {
"merchant_id": "<string>",
"merchant_name": "<string>",
"allowed_domains": [
"<string>"
],
"branding_profile": {
"accent_color": "<string>",
"background_color": "<string>",
"border_radius": "<string>",
"button_color": "<string>",
"button_text_color": "<string>",
"color_scheme": "<string>",
"created_at": "<string>",
"display_name": "<string>",
"focus_color": "<string>",
"font_family": "<string>",
"id": "<string>",
"is_default": true,
"merchant_id": "<string>",
"name": "<string>",
"primary_color": "<string>",
"updated_at": "<string>",
"button_text": "<string>",
"error_color": "<string>",
"logo_url": "<string>",
"success_color": "<string>",
"warning_color": "<string>"
},
"config": {},
"default_branding_profile_id": "<string>",
"outlet_id": "<string>"
},
"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, 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` differs from your key's bound outlet); `urn:radiumone:payment-gateway:checkout:origin-not-allowed` (payment-brands / payment-methods only: the browser Origin is not allowed); or `urn:radiumone:payment-gateway:merchant:outlet-disabled` (`retry_allowed: false`): the outlet -- named, key-bound or your DEFAULT -- is disabled.",
"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": "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"
}Get checkout context - Payments API
Retrieve the branding and resolved hosted checkout configuration that applies to your merchant account.
GET
/
v1
/
merchant
/
checkout
cURL
#!/usr/bin/env bash
# Retrieve your resolved hosted-checkout settings, as the Checkout API front
# end consumes them.
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 (secret key)}"
curl -sS "$API_BASE/v1/merchant/checkout" \
-H "Authorization: Bearer $RADIUMONE_ACCESS_TOKEN"#!/usr/bin/env python3
"""Retrieve your resolved hosted-checkout settings."""
import json
import os
import requests
API_BASE = os.environ.get("RADIUMONE_API_BASE", "https://api-sandbox.radiumone.io/gateway")
def get_merchant_checkout_settings() -> dict:
resp = requests.get(
f"{API_BASE}/v1/merchant/checkout",
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"merchant/checkout failed: {code} ({resp.status_code})")
return payload
if __name__ == "__main__":
print(json.dumps(get_merchant_checkout_settings(), indent=2))
{
"data": {
"merchant_id": "<string>",
"merchant_name": "<string>",
"allowed_domains": [
"<string>"
],
"branding_profile": {
"accent_color": "<string>",
"background_color": "<string>",
"border_radius": "<string>",
"button_color": "<string>",
"button_text_color": "<string>",
"color_scheme": "<string>",
"created_at": "<string>",
"display_name": "<string>",
"focus_color": "<string>",
"font_family": "<string>",
"id": "<string>",
"is_default": true,
"merchant_id": "<string>",
"name": "<string>",
"primary_color": "<string>",
"updated_at": "<string>",
"button_text": "<string>",
"error_color": "<string>",
"logo_url": "<string>",
"success_color": "<string>",
"warning_color": "<string>"
},
"config": {},
"default_branding_profile_id": "<string>",
"outlet_id": "<string>"
},
"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, 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` differs from your key's bound outlet); `urn:radiumone:payment-gateway:checkout:origin-not-allowed` (payment-brands / payment-methods only: the browser Origin is not allowed); or `urn:radiumone:payment-gateway:merchant:outlet-disabled` (`retry_allowed: false`): the outlet -- named, key-bound or your DEFAULT -- is disabled.",
"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": "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"
}Authorizations
Query 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.