| Table of Contents | ||||
|---|---|---|---|---|
|
1. Overview
The direct-debits resource is used by an AISP to retrieve the direct debits for a specific account identified by AccountId or to retrieve direct debits for all accounts that the customer has consented to.
This resource description should be read in conjunction with a compatible Account Information Services API Profile.
2. Endpoints
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Idempotency Key | Parameter | Request Object | Response Object |
2.1 | direct-debits | GET | GET /accounts/{AccountId}/direct-debits | Conditional | accounts | Authorisation Code | No |
|
| OBReadDirectDebit |
2.2 | direct-debits | GET | GET /direct-debits | Conditional | accounts | Authorisation Code | No | Pagination |
| OBReadDirectDebit |
2.1
...
GET /accounts/{AccountId}/direct-debits
An ASPSP must provide this endpoint for AISPs to retrieve the direct-debits for a specific account identified by AccountId.
2.2
...
GET /direct-debits
An ASPSP may provide this endpoint for AISPs to retrieve direct-debits for all accounts that the customer has consented to. This will retrieve the direct-debit resources for all authorised accounts linked to the account-request.
3. Data Data Models
3.1
...
OBReadDirectDebit
3.1.1 1 Resource Definition
A resource that contains a set of elements that describes the list of direct debits that have been set up on a specific account (AccountId). An account (AccountId) may have no direct debits set up, or may have multiple direct debits set up.
3.1.2 2 UML Diagram
...
3.1.3 Permission 3 Permission Codes
The resource requires the ReadDirectDebits permission. The resource response payload does not differ depending on the permissions granted.
3.1.4 Data 4 Data Dictionary
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBReadDirectDebit |
| OBReadDirectDebit |
| OBReadDirectDebit |
|
|
Data | 1..1 | OBReadDirectDebit/Data |
| OBReadDirectDebit/Data |
|
|
DirectDebit | 0..n | OBReadDirectDebit/Data/DirectDebit | Account to or from which a cash entry is made. | OBReadDirectDebit/Data/DirectDebit |
|
|
AccountId | 1..1 | OBReadDirectDebit/Data/DirectDebit/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | String |
|
|
DirectDebitId | 0..1 | OBReadDirectDebit/Data/DirectDebit/DirectDebitId | A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner. | String |
|
|
MandateIdentification | 0..1 | OBReadDirectDebit/Data/DirectDebit/MandateIdentification | Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference. | String |
|
|
DirectDebitStatusCode | 0..1 | OBReadDirectDebit/Data/DirectDebit/DirectDebitStatusCode | Specifies the status of the direct debit in code form. | String | Enum:
|
|
Name | 0..1 | OBReadDirectDebit/Data/DirectDebit/Name | Name of Service User. | String |
|
|
PreviousPaymentDateTime | 0..1 | OBReadDirectDebit/Data/DirectDebit/PreviousPaymentDateTime | Date of most recent direct debit collection. | DateTime |
|
|
Frequency | 0..1 | OBReadDirectDebit/Data/DirectDebit/Frequency | Regularity with which direct debit instructions are to be created and processed | String | Enum:
|
|
PreviousPaymentAmount | 0..1 | OBReadDirectDebit/Data/DirectDebit/PreviousPaymentAmount | The amount of the most recent direct debit collection. | OBReadDirectDebit/Data/DirectDebit/PreviousPaymentAmount |
|
|
Amount | 0..1 | OBReadDirectDebit/Data/DirectDebit/PreviousPaymentAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | String |
| ^\d{1,13}$\|^\d{1,13}\.\d{1,5}$ |
Currency | 0..1 | OBReadDirectDebit/Data/DirectDebit/PreviousPaymentAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | String |
| ^[A-Z]{3,3}$ |
4. Usage Usage Example
4.1
...
Bulk
4.1.1 Get Direct Debits Request
...
|
4.2
...
Specific Account
4.2.1 Get Account Direct Debits Request
...