Configure a gateway

POST /api/v1/admin/payments/config prm_settings

Upserts one gateway's credentials and settings. Every field is keep-existing, so a partial payload leaves unsent credentials alone rather than clearing them.

At a glance

Authentication: Staff token or session
Requires permission: prm_settings Manage settings
Rate limit: t_mutate

Parameters

Parameter	Description
`gateway`required body · string	Driver id from the catalogue.

Errors

Code	When it is returned
`ERR_VALIDATION`400	an unknown gateway id, or a field the driver does not accept

Request

curl -X POST "$BASE/api/v1/admin/payments/config" \
  -H "Authorization: Bearer $XR_TOKEN"

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us