API Details
- The
POST /credittransfers/collectionsAPI allows you to initiate multiple credit transfer transactions with a single request. - This API supports various schemes and currencies by incorporating key ISO20022 XML attributes.
- The request should include details about the collection, such as reference, batch booking preference, number of transactions, total amount, currency, etc.
- Additionally, the request should include payment information objects for each transaction.
- The API processes the request asynchronously and provides a response object with a unique collection ID, which can be used to track the status of the collection.
- This API is a part of a larger system that allows you to creation and manage credit transfer collections.
Idempotency
The Idempotency check is only against successful requests, so where a previous call has resulted in any of the following HTTP Response Codes, that Idempotency key may be reused without any issue:
401403404408500501503
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).