You are here: Basics > API Basics > Your First API Request

Your First API Request - List Creditor Schemes

All mandates that you create (and all subsequent Direct Debit payments) must be linked to a unique Creditor Scheme Identifier (CSID). This identifier (and its resource identifier) will be provided to you by Nuapay when you register or, if you have processed Direct Debit payments with another provider, you may already have a CSID that you may reuse in Nuapay. If you already have a CSID you will need to retrieve its Nuapay resource identifier.

Rather than use the actual CSID, requests to Nuapay require that you use a unique resource identifier to the CSID in your calls to the service.

If you lose this reference or if you have multiple CSIDs and want to review them all, you can use the List Creditor Schemes request. You will use this resource identifier CSID in all subsequent Mandate and Direct Debit requests.

You must use the resource identifier of the scheme in your requests. This identifier will be similar to this abxq9kq52l; do not reference the actual creditor scheme ID in your requests.

 

REQUEST
API Reference List Creditor Schemes
Usage Generally you will just need to make this request once
Method GET
URI /schemes

 

RESPONSE

A successful request will return a 200 Created response code

If you do not see a 200, see the HTTP Response Codes section of the API Reference to assist you to troubleshoot the issue.

At a minimum we recommend that you store the following data:

id An identifier that uniquely identifies each configured scheme in Nuapay (generally you will just have a single scheme)
uri A resolvable path containing the Creditor Scheme ID (CSID) resource identifier.