API reference

Public endpoints

Endpoints used by the hosted pages.

These endpoints power the hosted pages. They need no API key and expose only what a payer needs. You normally don’t call them — use checkoutUrl — but you can, for example to build a custom payment page on your own domain.

GET/public/brandpublic
GET/public/links/:slugpublic
POST/public/links/:slug/intentspublic

Body: { "payerName"?, "payerPhone"? } (required if the link asks). Creates the payer’s own payment.

GET/public/intents/:idpublic
POST/public/intents/:id/claimpublic

Body: { "transactionId", "reference"? }. Returns { outcome, intent }. Public claims are rate-limited and recorded in the audit log.

Payment ids are long random identifiers, so a checkout URL can’t be guessed. Public responses never include your API key, webhook data, other payments or SMS contents.
Previous
Payment links
Next
Rate limits