The List Payment Schedule request allows you to view a collection of payment schedules linked to:
- A Mandate/DDI
- A Specific Scheme
- All schemes (i.e. all schedules)
Use an appropriate URI (as described below) to return the required collection of Payment Schedules.
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).
paymentScheduleIdin your requests and not the actual creditor scheme ID/SUN or Unique Mandate Reference or payment schedule identifier. Resource identifiers are short alphanumeric strings, similar to this: abxq9kq52l. Depending on the request you may need 1, 2 or all 3 of these resource identifiers in your URI.