Use the Confirm service to prompt the user for the OTP and to retrieve the encoded identifier of the mandate created.
At the confirmation stage of the conversation:
- Use the
GET conversations/confirm
to render the Confirmation screen for your user. - The user will be prompted to provide the OTP (this was issued in the previous step of the conversation).
- Once the user has typed the code and clicked Submit, call
POST conversations/confirm
to verify the OTP - Once the code provided is verified, the mandate is created with the
encodedMandateId
,encodedSchemeId
andmandateId
being returned. Note that the mandate is now set tosigned": true
- An email will be triggered to the user to confirm the mandate has been activated (for SEPA) or that it has been created and will be passed to the debtor’s bank (for Bacs mandates).
Note:
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 and Webhooks 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).