Show methods at checkout - Payments API

Before you render payment options, ask the API which methods and brands your outlet can accept for this sale — see Supported payment methods for what a method type and brand are.

Discovery is advisory, not a guarantee. A method or brand can appear in the response without being transactable in every case (for example, a brand’s features object can describe a capability that isn’t fully wired up yet). Treat the response as a hint for your UI, and let the actual purchase or authorize call be the source of truth for whether a payment succeeds.

Steps

Get an access token

Both endpoints accept a secret key’s access token or a publishable key’s JWE — any valid merchant token works, with no scope requirement. Publishable-key callers must send an Origin header that matches one of your allow-listed domains, or the request is rejected with 403 urn:radiumone:checkout:origin-not-allowed.

This request requires a valid access token. See Authentication to obtain one with POST /v1/auth/token before you continue.

Call list payment brands with currency, channel and amount

Endpoint	Returns
`GET /v1/payment-methods`	Method types only: `type`, `display_name`, `priority_rank`
`GET /v1/payment-brands`	Methods → products (brands) and their `features` (for example 3D Secure or loyalty support)

Parameter	Required	Notes
`currency`	Yes	3-letter ISO 4217 code
`channel`	Yes	One of `CARD_PRESENT`, `ECOMMERCE`, `MOTO`, `PAYMENT_LINK`, `IN_APP`, `RECURRING` — the same enum used on Charge or authorize a payment
`outlet_id`	No	Defaults to your key’s bound outlet. Sending an `outlet_id` your key isn’t bound to returns `auth:outlet-binding-violation`
`amount`	No	Integer, minor units, ≥ 0. Only `list-payment-brands` accepts it

The channel enum above is the one that actually matters at request time. Some older references describe a different, informal list for this parameter — that list doesn’t correspond to any accepted value.

Render buttons from priority_rank and display_name

The response data includes outlet_id, currency, channel, payment_methods[] and evaluated_at (plus cache_hit for the brands endpoint). Each brand product carries code (for example visa or uob_irr), display_name, priority_rank, and a free-form features object — sort by priority_rank and label each button with display_name.

Method types
Brands and features

#!/usr/bin/env bash
# Discover which payment method TYPES you can accept for a currency/channel.
# Advisory only — a listed method isn't a guarantee it will transact (some
# groups can be configured without a live processing path).
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 or publishable)}"

curl -sS -G "$API_BASE/v1/payment-methods" \
  -H "Authorization: Bearer $RADIUMONE_ACCESS_TOKEN" \
  --data-urlencode "currency=SGD" \
  --data-urlencode "channel=ECOMMERCE"

#!/usr/bin/env node
// Discover which payment method TYPES you can accept for a currency/channel.
// Advisory only. Node 18+ ESM fetch. Env: RADIUMONE_ACCESS_TOKEN, RADIUMONE_API_BASE.
const API_BASE = process.env.RADIUMONE_API_BASE || "https://api-sandbox.radiumone.io/gateway";
const accessToken = process.env.RADIUMONE_ACCESS_TOKEN;

async function listPaymentMethods({ currency = "SGD", channel = "ECOMMERCE" } = {}) {
  const params = new URLSearchParams({ currency, channel });
  const res = await fetch(`${API_BASE}/v1/payment-methods?${params}`, {
    headers: { Authorization: `Bearer ${accessToken}` },
  });
  const payload = await res.json();
  if (!res.ok) {
    throw new Error(`payment-methods failed: ${payload.type ?? payload.code} (${res.status})`);
  }
  return payload;
}

listPaymentMethods().then((r) => console.log(JSON.stringify(r, null, 2)));

#!/usr/bin/env python3
"""Discover which payment method TYPES you can accept for a currency/channel.
Advisory only.
"""
import json
import os

import requests

API_BASE = os.environ.get("RADIUMONE_API_BASE", "https://api-sandbox.radiumone.io/gateway")


def list_payment_methods(currency: str = "SGD", channel: str = "ECOMMERCE") -> dict:
    resp = requests.get(
        f"{API_BASE}/v1/payment-methods",
        params={"currency": currency, "channel": channel},
        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"payment-methods failed: {code} ({resp.status_code})")
    return payload


if __name__ == "__main__":
    print(json.dumps(list_payment_methods(), indent=2))

#!/usr/bin/env bash
# Discover payment brands/products and their features (3DS, loyalty) for a
# currency/channel/amount. Advisory only.
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 or publishable)}"

curl -sS -G "$API_BASE/v1/payment-brands" \
  -H "Authorization: Bearer $RADIUMONE_ACCESS_TOKEN" \
  --data-urlencode "currency=SGD" \
  --data-urlencode "channel=ECOMMERCE" \
  --data-urlencode "amount=5000"

#!/usr/bin/env node
// Discover payment brands/products and their features (3DS, loyalty) for a
// currency/channel/amount. Advisory only. Node 18+ ESM fetch.
// Env: RADIUMONE_ACCESS_TOKEN, RADIUMONE_API_BASE.
const API_BASE = process.env.RADIUMONE_API_BASE || "https://api-sandbox.radiumone.io/gateway";
const accessToken = process.env.RADIUMONE_ACCESS_TOKEN;

async function listPaymentBrands({ currency = "SGD", channel = "ECOMMERCE", amount = 5000 } = {}) {
  const params = new URLSearchParams({ currency, channel, amount: String(amount) });
  const res = await fetch(`${API_BASE}/v1/payment-brands?${params}`, {
    headers: { Authorization: `Bearer ${accessToken}` },
  });
  const payload = await res.json();
  if (!res.ok) {
    throw new Error(`payment-brands failed: ${payload.type ?? payload.code} (${res.status})`);
  }
  return payload;
}

listPaymentBrands().then((r) => console.log(JSON.stringify(r, null, 2)));

#!/usr/bin/env python3
"""Discover payment brands/products and their features (3DS, loyalty) for a
currency/channel/amount. Advisory only.
"""
import json
import os

import requests

API_BASE = os.environ.get("RADIUMONE_API_BASE", "https://api-sandbox.radiumone.io/gateway")


def list_payment_brands(currency: str = "SGD", channel: str = "ECOMMERCE", amount: int = 5000) -> dict:
    resp = requests.get(
        f"{API_BASE}/v1/payment-brands",
        params={"currency": currency, "channel": channel, "amount": amount},
        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"payment-brands failed: {code} ({resp.status_code})")
    return payload


if __name__ == "__main__":
    print(json.dumps(list_payment_brands(), indent=2))

Charge with the method the shopper picks

Send the shopper’s choice on the purchase or authorize request. Discovery only tells you what to render — the charge call is still the source of truth for whether the payment succeeds.

Caching

Results are cached for 60 seconds per (merchant, outlet, currency, channel, amount bucket). Don’t call discovery on every keystroke of a checkout form — cache the result on your side for the lifetime of the page, too.

Errors

Defined once on Payment method errors: Discovery:

checkout:origin-not-allowed
auth:outlet-binding-violation — outlet_id doesn’t match your key’s bound outlet
checkout:outlet-not-found
checkout:currency-not-supported
checkout:no-candidates

Next steps

Supported payment methods

What a method type and brand are, and what’s available today.

Charge or authorize a payment

The channel enum used across purchase, authorize and discovery.

Introduction

Guides

Payment methods

3D Secure

Handle failures

Webhooks

Errors

Reference

Show methods at checkout - Payments API

Steps

Caching

Errors

Next steps

Supported payment methods

Charge or authorize a payment

​Steps

​Caching

​Errors

​Next steps

Supported payment methods

Charge or authorize a payment

Steps

Caching

Errors

Next steps