Querying mandates

Mandates that are registered 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. Mandates are identified by their 'mandateidentification' which is simply the unique reference used with BankTech. Mandates can be queried in 3 ways:

GET: /mandates/{mandateIdentification}

This will fetch the entire mandate model for a given mandateidentification.

  • Rate limit: 1 per second

  • Payload size: 1 mandate

GET: /mandates/summarised

This will fetch the summarised version of the mandate model for a set of mandates meeting the specified criteria and data ranges.

  • Rate limit: 1 per second

  • Payload size: 5,000 mandates

GET: /mandates/detailed

This will fetch the detailed version of the mandate model for a set of mandates meeting the specified criteria and data ranges.

  • Rate limit: 1 per second

  • Payload size: 5,000 mandates

Last updated

Was this helpful?