List CTs in a Collection RESTful API
API Details
Important: The JWS-Signature header is required for this endpoint.
- The
GET /credittransfers/collections/{collectionId}/credittransfers
endpoint allows you to view all the payments connected to a collection of CT payments. - This endpoint reuses the same object structure as the standard credit transfer endpoint, ensuring consistency across the API.
- You can filter the list of credit transfers using parameters such as end-to-end ID, beneficiary IBAN, beneficiary name, and execution date range.
- For collections with a status of
QUEUED
, the endpoint returns anHTTP 202 (ACCEPTED)
response with no body, indicating that the list of credit transfers is not yet available. - For other collection statuses, the endpoint returns a standard HTTP 200 (OK) response containing a list of credit transfer objects with details like originator IBAN, requested and actual execution dates, payment amount and currency, end-to-end ID, remittance information, payment status, type, and payment scheme.
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 .