Skip to main content
🪙

Direct Debit

Set up your Direct Debit integration. Manage the bank accounts authorized for debit collection and register the callback URL for real-time payment notifications.

🏦 Wide bank coverage (60+ banks)🧾 Instant mandate creation🔐 Secure authorization flow📡 Real-time debit status updates

Mandate Flow​

Follow these four steps in order. Each step builds on data from the previous one.

1
Fetch Supported Banks

Call Bank List to retrieve all supported banks and their bankCode values. These are required when creating a mandate.

2
Create a Mandate

Use the Create Mandate endpoint to initialize a mandate. Pass customer details such as accountNumber, bankCode, amount, and reference. The response returns a mandateId used in later steps.

3
Debit the Mandate

Initiate a debit using the Debit Mandate endpoint. Provide the mandateId, amount, and a unique reference. This triggers a payment attempt against the active mandate.

4
Check Mandate Status

Use Mandate Status with the mandateId to retrieve the current state of the mandate. This confirms whether it is active, processing, or any other system-defined status.

Important Notes​

Always verify mandate status

A successful HTTP response does not guarantee the mandate is active or the debit succeeded. Always check data.status in the response body for the actual state.

Required identifiers

Ensure you store and reuse the mandateId returned from the Create Mandate step. It is required for both debit and status tracking operations.

Endpoints​