Direct Debit Payments
A Direct Debit payment records each attempt to collect money from a customer’s bank account, including the amount, collection date, outcome, and provider status. These records are created by collection runs, so the API exposes them read-only for monitoring and reconciliation.
Methods
Section titled “Methods”Retrieve Single Direct Debit Payment
Section titled “Retrieve Single Direct Debit Payment”/backend/api/v1/directDebitPayments/ID - fetch the Direct Debit payment with the specified ID.
List Direct Debit Payments
Section titled “List Direct Debit Payments”/backend/api/v1/directDebitPayments/ - list all Direct Debit payments.
/backend/api/v1/payments/ID/directDebitPayments/ - list the Direct Debit collection attempts for the payment with the specified ID.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include payments with a higher ID |
createdSince | datetime | No | Only include payments created since the given time |
updatedSince | datetime | No | Only include payments updated since the given time |
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| ourReference | Our Reference | Text | Internal reference number for this direct debit payment |
| customerReference | Customer's Reference | Text | Reference number provided by the customer for this direct debit payment |
| directDebitAccountID | Direct Debit Account | Text | The direct debit account used for this payment |
| directDebitRun | Direct Debit Run | Preset Value | The direct debit run this payment is part of |
| directDebitPaymentAmount | Amount | Currency | The amount to be collected via direct debit |
| collectionDate | Collection Date | Date | The date when the direct debit collection is scheduled |
| status | Payment Status | Preset Value | Current status of the direct debit payment |
| directDebitPaymentSetupStamp | Requested Date | Date | Date when the direct debit payment was requested |
| directDebitPaymentTakenStamp | Taken Date | Date | Date when the direct debit payment was successfully taken |
| directDebitPaymentFailedStamp | Failed Date | Date | Date when the direct debit payment failed |
| providerStatus | Provider Status | Text | Status code returned by the direct debit provider |
| providerStatusDetail | Provider Status Detail | Text | Detailed status information from the direct debit provider |
| providerPaymentReference | Provider Reference | Text | Reference number assigned by the direct debit provider |
| retryCount | Retry Count | Number | Number of times collection has been attempted |
| id | Direct Debit Payment ID | Text | The unique identifier for this direct debit payment |