Skip to main content
PUT
Update 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.

Body

application/json

Provide one or both fields: enabled_payment_methods and fee_preference.

enabled_payment_methods
object
required

The corridors to offer at checkout, keyed by exact corridor (USD_CARD, NGN_CARD, NGN_BANK_TRANSFER, MOMO_GHS..MOMO_ZMW, CRYPTO) -- see payment method support. Each entry you send must carry an enabled boolean; CRYPTO additionally accepts a currencies map of per-asset booleans. This replaces the stored configuration wholesale: a corridor you omit resets to its platform default rather than keeping its current state.

fee_preference
enum<string>

Who pays the processing fee on a checkout from now on. 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. Omit the field to leave the current preference untouched.

Available options:
customer_pays,
org_pays
Example:

"org_pays"

Response

Success - Checkout settings updated

organization_id
string

The account whose settings were updated, 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 stored configuration after the update, keyed by exact corridor. The update replaces the whole map, so this returns the corridors you sent and nothing else. Read it back to confirm which corridors are now live at checkout.

fee_preference
enum<string>

Who now pays the processing fee on a checkout. 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:

"org_pays"

message
string

A confirmation string for the update. Do not branch on it, since the returned enabled_payment_methods and fee_preference carry the state you should check.

Example:

"Checkout settings updated successfully"