Skip to main content
GET
Get checkout settings

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Headers

X-Account-Id
string

Account ID when acting on behalf of a sub-account.

Response

Success - Checkout settings retrieved

organization_id
string

The account these settings apply to, which is the account your API key belongs to, or the account you named in X-Account-Id.

Example:

"acct_7KpQ2mNv4XbR9dLc"

enabled_payment_methods
object

The methods a customer can pay with at checkout, keyed by exact corridor (USD_CARD, NGN_CARD, NGN_BANK_TRANSFER, MOMO_GHS..MOMO_ZMW, CRYPTO) -- see payment method support. Each entry carries an enabled flag; CRYPTO alone additionally carries a currencies map (per-asset toggles), since every other corridor already names its one currency in the key itself.

fee_preference
enum<string>

Who pays the processing fee on a checkout, unless the individual checkout overrides it. customer_pays: the fee is added on top of the amount the customer pays, so you settle the full amount. org_pays: you absorb the fee and it is netted out of what settles into your balance.

Available options:
customer_pays,
org_pays
Example:

"customer_pays"

available_currencies
object

Every currency each corridor is configured to accept on the platform, keyed by the same exact corridors as enabled_payment_methods, so you know which currencies you can switch on before you send an update.