Public reference

Payments

Every endpoint in this group. Open one for its parameters and a worked example.

14 Endpoints

View as Markdown

Payments

GET /api/v1/admin/payments/config List configured gateways prm_settings

Just the tenant's configured rows, with credentials masked, for a page that already holds the catalogue.

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

Open the full reference

POST /api/v1/admin/payments/config Configure a gateway 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.

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.

Open the full reference

DELETE /api/v1/admin/payments/config/{gateway} Remove a gateway configuration prm_settings

Deletes the tenant's credentials for one driver. Transactions already recorded against it are untouched.

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

Parameters

Parameter	Description
`gateway`required path · string	Driver id.

Open the full reference

PATCH /api/v1/admin/payments/config/{gateway} Update one gateway's configuration prm_settings

The same upsert as the POST, with the gateway named in the path. The PATH wins over any gateway field in the body, so a stale client cannot retarget an edit at a different gateway.

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

Parameters

Parameter	Description
`gateway`required path · string	Driver id.

Open the full reference

POST /api/v1/admin/payments/config/{gateway}/test Test a gateway configuration prm_settings

Checks the stored credentials against the provider.

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

Parameters

Parameter	Description
`gateway`required path · string	Driver id.

Open the full reference

GET /api/v1/admin/payments/config/{gateway}/webhook-url Read a gateway's callback URL prm_settings

The exact URL to register with the provider, including the per-tenant secret path segment. Copy it verbatim.

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

The URL contains a secret. It is what proves an inbound callback came from the provider you configured, so treat the response as a credential and do not paste it into a ticket.

Parameters

Parameter	Description
`gateway`required path · string	Driver id.

Open the full reference

POST /api/v1/admin/payments/deposit Top up own wallet online prm_managers_self_deposit

Authentication: Staff token or session
Requires permission: prm_managers_self_deposit Top up own wallet online
Rate limit: pay_init

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/admin/payments/deposit/gateways Top up own wallet online prm_managers_self_deposit

Authentication: Staff token or session
Requires permission: prm_managers_self_deposit Top up own wallet online

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/admin/payments/gateways List the gateway catalogue and what is configured 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.

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

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.

Open the full reference

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"
  }
}

GET /api/v1/admin/payments/transactions/{id}

Authentication: Staff token or session
Requires any one of: prm_report_gateway_transactions prm_report_gateway_transactions_all

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/admin/payments/transactions/{id}/recheck Re-check and write off gateway transactions prm_payments_manage

Authentication: Staff token or session
Requires permission: prm_payments_manage Re-check and write off gateway transactions
Rate limit: pay_init

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/admin/payments/transactions/{id}/refund Mark gateway payments paid / refunded (moves money) prm_payments_settle

Authentication: Staff token or session
Requires permission: prm_payments_settle Mark gateway payments paid / refunded (moves money)
Rate limit: pay_init

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/admin/payments/transactions/{id}/settle Mark gateway payments paid / refunded (moves money) prm_payments_settle

Authentication: Staff token or session
Requires permission: prm_payments_settle Mark gateway payments paid / refunded (moves money)
Rate limit: pay_init

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/admin/payments/transactions/{id}/status Re-check and write off gateway transactions prm_payments_manage

Authentication: Staff token or session
Requires permission: prm_payments_manage Re-check and write off gateway transactions
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

Written to be read by machines too

The reference is public and needs no account, so a tool that has never seen X-Radius can reach a correct first call on its own.

/llms.txt: An index of every page, with one-line summaries.
/llms-full.txt: The whole reference as one Markdown file, with no navigation to crawl.
/openapi.json: OpenAPI 3.1, generated from the router that serves this instance.
/skill.md: A ready-made skill file for an assistant: authentication, the response envelope and the error codes in one page.
<page-url>.md: Append .md to any reference URL for the same page as Markdown.
Accept: text/markdown: Send this header on the ordinary URL and the answer comes back as Markdown instead.

Hand this to your assistant

Read https://x-radius.com/llms.txt, then fetch the endpoint you need as Markdown by appending .md to its URL.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us