View a CT Collection RESTful API
API Details
Important: The JWS-Signature header is required for this endpoint.
- The
GET /credittransfers/collections/{collectionId}endpoint allows you to retrieve information about a specific collection using its unique ID, which is generated during the creation process using thePOST /credittransfers/collectionsAPI. - This endpoint returns a response object similar to the one from the POST request, including details such as the collection ID, reference, requested execution date, actual execution date, number of transactions, total amount, etc.
- Additionally, this endpoint provides access to view the credit transfers associated with a particular collection (through a link to the
GET /credittransfers/collections/{collectionId}/credittransfers)endpoint. - The response will display different collection statuses depending on the stage of processing, ranging from
QUEUEDtoCOMPLETEorCOMPLETE WITH ERRORS(see Credit Transfer Statuses for details on the various possible statuses).
Swagger Reference:
Credit Transfers
Note:
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).
Tip: The Collections CT APIs are Asynchronous and available under the v2 CT Swagger .