As outlined in Create Payment Schedule, before you can add a schedule of Direct Debit payments for a payer you must first have an Active mandate in place; so two separate requests are required: one to create and activate a mandate and a second to add the schedule of payments.
The Create Payment Schedule and Mandate request allows you to combine these two request so that you can create a mandate and a payment schedule in a single request.
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
|Usage||Both the schedule and mandate details must be provided|
Possible values: DAILY, WEEKLY, BIWEEKLY, MONTHLY, YEARLY, CUSTOM
The Settlement Date of the first payment in the schedule
The value of the regular payment to be collected. Max length without decimals is 12 digits. Decimal separator is “.” A maximum of two decimal places is allowed.
Where you have selected CUSTOM as the paymentFrequency, you must specify either 3 (for quarterly) or 6 (for bi-anually)
Note: Other arguments may be required depending on your schedule requirements (for example if you are setting up a FIXED_LENGTH schedule then the numberOfPayments is mandatory).
A successful request will return a 201 Created response code
The following is the complete list of possible status codes, which may be returned in the response:
|200||OK - The request completed successfully.|
|201||Created - A new resource has been created successfully. The resource is appended to the response.|
|400||Bad Request - The request was malformed. The response body will include an error providing further information.|
|401||Unauthorized - Your API key is wrong.|
|403||Forbidden - The client has provided a valid Authentication header, but it does not have permission to access this resource.|
|404||Not Found - The requested resource did not exist.|
|405||Method Not Allowed - When a HTTP method is being requested that isn’t allowed.|
|410||Gone - The API requested has been removed from our servers.|
|412||Precondition Failed - Certain unmet conditions must be fulfilled before the request to be processed e.g. timestamp is too old.|
|415||Unsupported Media Type - If incorrect content type was provided as part of the request (e.g. other than “application/json”).|
|422||Unprocessable Entity - Used for validation errors. More details will be provided in response body.|
|500||Internal Server Error - We had a problem with our server. Try again later and if the problem persists contact the Nuapay application support team.|
|501||Not Implemented - When the endpoint is not implemented yet.|
|503||Service Unavailable - We’re temporarially offline for maintanance. Please try again later.|
Note: For a more detailed view of this API see the: API Reference