Reference
Endpoint reference for the Payfet API.
API reference
The full generated reference is still being written. The checkout endpoints below are live and documented in full on Accept payments on your site.
Checkout
Base URL https://api.payfet.org.
| Method | Endpoint | Auth | Purpose |
|---|---|---|---|
POST | /v1/checkout/sessions/ | Tenant token | Create a checkout, get a checkout_url |
GET | /v1/checkout/sessions/{reference}/ | Tenant token | Status of one checkout |
GET | /v1/checkout/{slug}/ | None | What the hosted page renders |
POST | /v1/checkout/{slug}/initiate/ | None | Issue the bank account for a payer |
GET | /v1/checkout/{slug}/status/ | None | Poll while the payer transfers |
The unauthenticated endpoints are what the hosted checkout page itself calls. Your customers have no Payfet account, so those cannot require credentials.
Authentication
http
X-Tenant-Token: your access token
X-Tenant-Secret: your secret key
X-Tenant-BID: your business idFrom Payfet for Business → Settings → Token. Server-side only.
Need help?
Email support@payfet.org.