E-Mandates may be used in the following modes:
Regardless of the approach you take, the Prepare E-Mandate API is required.
An E-Mandate token is a session ID that is the starting point for your electronic mandate.
The Token encapsulates the following:
- Your Merchant configurations (Signing Method, UI customisations, Debtor/Payer Input Allowed, etc.)
- Merchant-specific details (Creditor Scheme ID, Scheme Type, etc.)
- Payer details (Address details, phone details, email, etc.)
- Contract Identifier (optional, if you want to combine a contract and mandate - see E-mandate and Contract)
When working with our APIs, please use the Sandbox URI when testing and the Live URI when you move to Production.
LIVE https://api.nuapay.com SANDBOX https://sandbox.nuapay.com/
If you haven't done so already and would like to do some testing, please Request Sandbox Access
Important: Endpoints may be extended from time to time and any changes we make will follow our Versioning and Backward Compatibility rules. This means that the code that you write today must be designed to be robust enough to handle any future changes (where a new object is added to (or removed from) a specific API response, for example).
To retrieve your token you must make a Prepare E-Mandate request: