List the gateway catalogue and what is configured

GET /api/v1/admin/payments/gateways prm_settings

The drivers this build supports, the tenant's own configured rows with secrets masked, and the public base URL a gateway should call back to.

Read implemented and pollable before building against a driver. implemented false is a registry stub whose vendor contract is not verified; pollable false means the gateway has no merchant-readable status API, so its callback is the only channel and a lost callback is a lost payment. min_amount is the PSP's own floor in major units, and 0 means no floor.

At a glance

Authentication: Staff token or session
Requires permission: prm_settings Manage settings

Request

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

Response 200 OK

{
  "data": {
    "catalog": [
      {
        "id": "paymob",
        "label": "Paymob",
        "methods": [],
        "fields": [],
        "ttl_seconds": 900,
        "min_amount": 0,
        "implemented": true,
        "pollable": true
      }
    ],
    "configured": [],
    "public_base_url": "https://acme.example.com"
  }
}

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