Create Direct Debit & Mandate RESTful API - generate a mandate and a payment in a single API call.
Edit me

API Details

As outlined in the Create Direct Debit call, you must have an active mandate before you can begin to collect Direct Debit payments. Typically you would use the Create Mandate call and then reference the successfully activated mandate when you create the Direct Debit payment.

The Create Direct Debit and Mandate call allows you to combine these separate requests into a single call; the request performs two operations:

  • A mandate is created in Active status
  • A Direct Debit payment is created and linked to the new mandate

The Create Direct Debit and Mandate request must include:

  • A requested collection date for the Direct Debit payment
  • The payment amount
  • The payer’s name
  • The payer’s IBAN
  • The Merchant Nuapay IBAN
Usage The requested collection date and amount are required along with the mandate details.
Method POST
URI /schemes/{CS_ID}/directdebits

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:

Status Code Description
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