You are here: Basics > API Basics > A Note on API Descriptions

A Note on API Descriptions

All Nuapay API requests are described in this Developer documentation and all follow the same format:

  • Business Overview of the request
  • Details of the Request (a link to the API reference, usage, method and URI)
  • Details of the Response (The Response code and returned values)

Note that in the majority of requests you will need to pass one or more unique resource identifiers. Where you need to supply a resource ID this is indicated in the Request section in brackets; for example the Creditor Scheme resource identifier: {CS_ID}

Where you need to provide a resource identifier for a specific Creditor Scheme, Mandate and Direct Debit, for example, the request would indicate the following (As outlined in the Retrieve Direct Debit request):

/schemes/{CS_ID}/mandates/{MANDATE_ID}/directdebits/{DD_ID}

This request on the Sandbox environment would resemble this:

https://sandbox.nuapay.com//schemes/qtxq9kq52l/mandates/abxq6yt58l/directdebits/cdxr3kq72l