APIs
Please find below the API details for the Currence eMandate module.
The API will only be useable if the module has been licensed by the client.
In the URL, vx.x.x denotes the swagger version that client has licensed.
Endpoint | Method | URL | Description |
---|---|---|---|
createMandateConsent | POST | http://<hostname>:<jboss_port>/nlmb-provider-iris/api/vx.x.x/order/nl/directDebits/mandates/consents | This API is used to initiate the creation of the E-Mandate. This API will create a mandate request in Staging application with the status as OPEN. |
updateMandateConsent | PUT | http://<hostname>:<jboss_port>/nlmb-provider-iris/api/vx.x.x/order/nl/directDebits/mandates/{mandateId}/consents | This API is called to update the mandate record created in the Staging application with the customer's decision and the debit account details. |
getMandate | GET | http://<hostname>:<jboss_port>/nlmb-provider-iris/api/vx.x.x/order/nl/directDebits/mandates/consents | This API will get all the details that were passed in during the request for creation of the mandate. This API will be called to check the existence of the request in the transact before the customer is asked to authorise it. |
getMandateDetails | GET | http://<hostname>:<jboss_port>/nlmb-provider-iris/api/vx.x.x/order/nl/directDebits/mandates/{transactionReference} | This API will fetch the detailed information about the mandate that is created including the status of the mandate. |
In this topic