API reference
Every endpoint you can call with an API key. Base URL https://api.tfolanodal.com; send Authorization: Bearer np_live_… on every request.
Parameters, responses and errors for each endpoint are in its guide. Formats, idempotency, errors, statuses and pagination are in Requests and errors.
Hosted checkout
| Endpoint | Does | Idempotency-Key |
|---|---|---|
POST /checkout/sessions | Create a session | required |
GET /checkout/sessions/:id | Get a session | |
POST /checkout/sessions/:id/cancel | Cancel an open session | — |
Collections
| Endpoint | Does | Idempotency-Key |
|---|---|---|
POST /collections | Prompt a customer to pay | recommended |
GET /collections | List payments | |
GET /collections/:id | Get a payment |
Payment links
| Endpoint | Does | Idempotency-Key |
|---|---|---|
POST /payment-links | Create a link | — |
GET /payment-links | List links with totals | |
POST /payment-links/:id/deactivate | Stop a link accepting payments | — |
Mandates
| Endpoint | Does | Idempotency-Key |
|---|---|---|
POST /mandates | Create a mandate | recommended |
GET /mandates | List mandates | |
GET /mandates/:id | Get a mandate | |
GET /mandates/:id/collections | List a mandate's debits | |
PATCH /mandates/:id | Change the reference | |
POST /mandates/:id/pause | Pause debits | — |
POST /mandates/:id/resume | Resume a paused or suspended mandate | — |
POST /mandates/:id/reauthorise | Ask the customer to approve again | — |
POST /mandates/:id/cancel | End the mandate | — |
Repeating requests
| Endpoint | Does | Idempotency-Key |
|---|---|---|
POST /repeating-requests | Set up a repeating request | — |
GET /repeating-requests | List repeating requests | |
GET /repeating-requests/:id | Get one, with its periods and prompts | |
PATCH /repeating-requests/:id | Change the reference | |
POST /repeating-requests/:id/prompt | Prompt now for the open period | — |
POST /repeating-requests/:id/skip | Skip the open or next period | — |
POST /repeating-requests/:id/pause | Pause prompts | — |
POST /repeating-requests/:id/resume | Resume, or restart an ended one | — |
POST /repeating-requests/:id/end | End it | — |
Payouts
| Endpoint | Does | Idempotency-Key |
|---|---|---|
POST /payouts | Request a payout (needs approval) | recommended |
GET /payouts | List payouts | |
GET /payouts/:id | Get a payout |
Refunds
| Endpoint | Does | Idempotency-Key |
|---|---|---|
POST /refunds | Request a refund (needs approval) | recommended |
GET /refunds | List refunds | |
GET /refunds/:id | Get a refund |
Done in the portal only
These need a person signed in at the portal and refuse API keys with 403: approving or rejecting payouts and refunds; API keys; webhook endpoints, secrets, test events and redelivery; MTN credentials; team members and roles; balances, reports and data exports; billing; changing a repeating request's amount, window or limits, or moving it to a mandate.