List Payment Schedules RESTful API
Edit me

API Details

The List Payment Schedule request allows you to view a collection of payment schedules linked to:

  • A Mandate
  • A Specific Scheme
  • All schemes (i.e. all schedules)

Use an appropriate URI (as described below) to return the required collection of Payment Schedules.

Usage You can return all payment schedules or filter based on mandate or by scheme
Method GET
URI /paymentschedules
URI (Option 2) /schemes/{CS_ID}/mandates/{MANDATE_ID}/paymentschedules
URI (Option 3) /schemes/{CS_ID}/paymentschedules

A successful request will return a 200 OK 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