⬡ Nodal Docs

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

EndpointDoesIdempotency-Key
POST /checkout/sessionsCreate a sessionrequired
GET /checkout/sessions/:idGet a session
POST /checkout/sessions/:id/cancelCancel an open session—

Collections

EndpointDoesIdempotency-Key
POST /collectionsPrompt a customer to payrecommended
GET /collectionsList payments
GET /collections/:idGet a payment

Payment links

EndpointDoesIdempotency-Key
POST /payment-linksCreate a link—
GET /payment-linksList links with totals
POST /payment-links/:id/deactivateStop a link accepting payments—

Mandates

EndpointDoesIdempotency-Key
POST /mandatesCreate a mandaterecommended
GET /mandatesList mandates
GET /mandates/:idGet a mandate
GET /mandates/:id/collectionsList a mandate's debits
PATCH /mandates/:idChange the reference
POST /mandates/:id/pausePause debits—
POST /mandates/:id/resumeResume a paused or suspended mandate—
POST /mandates/:id/reauthoriseAsk the customer to approve again—
POST /mandates/:id/cancelEnd the mandate—

Repeating requests

EndpointDoesIdempotency-Key
POST /repeating-requestsSet up a repeating request—
GET /repeating-requestsList repeating requests
GET /repeating-requests/:idGet one, with its periods and prompts
PATCH /repeating-requests/:idChange the reference
POST /repeating-requests/:id/promptPrompt now for the open period—
POST /repeating-requests/:id/skipSkip the open or next period—
POST /repeating-requests/:id/pausePause prompts—
POST /repeating-requests/:id/resumeResume, or restart an ended one—
POST /repeating-requests/:id/endEnd it—

Payouts

EndpointDoesIdempotency-Key
POST /payoutsRequest a payout (needs approval)recommended
GET /payoutsList payouts
GET /payouts/:idGet a payout

Refunds

EndpointDoesIdempotency-Key
POST /refundsRequest a refund (needs approval)recommended
GET /refundsList refunds
GET /refunds/:idGet 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.