Querying collections

Collections that are scheduled with BankTech may be queried to inspect their data. This is usually done to facilitate the display or use of that data elsewhere or in the comparison of this data against another data set. Collections are identified by their 'collectionidentification' which is simply the unique reference used with BankTech. Collections can be queried in 3 ways:

GET: /collections

This will fetch the entire collection model for all collections meeting the specified filter criteria.

• Rate limit: 1 per second

• Payload size: 1

GET: /collections/{collectionIdentification}

This will only fetch the collectionidentification for any single collection.

• Rate limit: 1 per second

• Payload size: 1

You can obtain a collectionidentification by using the GET: /collections or POST: /mandates/collections/identifications methods to find a specific collection.

POST: /mandates/collections/identifications

This will fetch the entire collection model for all collections related to a mandate.

• Rate limit: 1 per second

• Payload size: 1

In this case, collections are fetched for a given mandateidentification. This method cannot be used to find ad-hoc collections that are not linked to a mandate.