List Direct Debits
The List Direct Debits request allows you to view a collection of direct debits linked to a:
- Specific Scheme
- All schemes (i.e. all payments)
Use an appropriate URI (as described below) to return the required collection of Direct Debits.
|API Reference||List Direct Debits|
|Usage||You can return all direct debits or filter based on mandate or by scheme|
The following are optional arguments:
|actualcollectiondatefrom||Use this value to filter your query to return details of Direct Debits created from this date. Format is yyyy-mm-dd.|
Use this value to filter your query to return details of Direct Debits created up to this date.
Format is yyyy-mm-dd.
|scheduleid||If you want to filter based on a specific payment schedule you can provide its ID.|
|paymentstatus||Provide a specific status to filter the date returned by your response (see Payment Statuses for more information on the various statuses)|
A successful request will return a 200 OK response code
The response includes:
|id||A resource identifier that uniquely identifies the collection in Nuapay|
|uri||A resolvable path containing the resource identifier of the merchant scheme, the mandate and the direct debits.|
|endToEndId||A unique identifier for each individual payment in the collection.|
|paymentAmount||The value of the direct debit|
|requestedCollectionDate/ actualCollectionDate||The collection date for each payment. In some cases there may be a difference between the requested and the actual collection date; note that the actual collection date is the date on which funds will be debited from your payer and credited to your merchant account.|
|exportDate||The date on which each payment will be passed from Nuapay to ClearingThe Clearing and Settlement Mechanism (CSM) that processes SEPA payments (The EBA's STEP-2 system allows banks across Europe to use one channel to send and receive their SEPA Credit Transfer and SEPA Direct Debit transactions) for further processing; on this date the status of the payment moves from READY FOR EXPORT to EXPORTED|
|remittanceInformation||The remittance or narrative linked to each payment.|
|representationAttemptNumber||The number of attempts made to re-present individual payments. A re-presentation is carried out where a direct debit has been rejected and a new payment is created to attempt to re-try the collection.|
|paymentStatus||The current status of each payment|