Retrieve active direct debit mandates and payment information associated with an account
Direct Debits API provides access to direct debit arrangements linked to a customer account. Direct debit information can be used to understand recurring payment obligations, monitor subscriptions, assess financial commitments, and support affordability and risk assessments.
A direct debit is an authorization that allows an organization to collect payments directly from a customer's bank account on an agreed schedule.
The Direct Debits API enables you to:
Access to this API requires a valid consent that has been authorized by the customer.
consentId must refer to an active and authorized consentAuthorization: Bearer headerThis API can only be accessed using a valid and active consent. Before accessing this service, ensure that a consent has been created and authorized with the required useCaseType and permissions.
The consent must include the appropriate useCaseType and permission values that allow access to the corresponding financial data services.
If you do not already have a consent with the required configuration, you must first create one using the Create Consent API and ensure that it is successfully authorized. Once the consent becomes active, the generated consentId can be used to access this API service.
Scope | useCaseType | Permissions |
|---|---|---|
To access all AIS API services:
|
|
|
This service requires consentId and accountId to return all the direct debits of an account associated with that consent.
Endpoint URL | Method |
|---|---|
| GET |
The following headers must be included when calling the Direct Debits API.
Header parameter | Description |
|---|---|
| Access token used to authenticate the API request |
curl --request GET \
--url 'https://obsandbox.onesingleview.com/v2/api/observice/directDebitsById?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&bankCode=SVMOB1&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&accountId=100004000000000000000001' \
--header 'accept: application/json' \
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'Request parameters
Parameters | Requirement | Description | Data type | Data validation |
|---|---|---|---|---|
dateTimeStamp | Mandatory | Indicates the date and time when the request is created | Date | ISO 8601 format |
requestID | Mandatory | Unique identifier for the request used for tracking and traceability | Alphanumeric | UUID format |
merchantID | Mandatory | Identifier assigned to the merchant or client application initiating the request | String |
|
bankCode | Mandatory | Unique bank identifier code | Enum |
|
consentId | Mandatory | Unique identifier of the consent | String |
|
accountId | Mandatory | Unique identifier of bank account associated with the consent | String |
|
{
"success": true,
"payload": [
{
"code": "SVMOB1",
"data": {
"accountId": "100004000000000000000001",
"directDebit": [
{
"directDebitId": "001000000000000000000121",
"mandateIdentification": "7248812485188",
"directDebitStatusCode": "Active",
"name": "SAINSBURYS BANK",
"previousPaymentDateTime": "2017-11-21T00:00:00.000Z",
"frequency": "KSAOB.Annual",
"previousPaymentAmount": {
"amount": "269.83",
"currency": "SAR"
}
}
],
"currentMonthPaid": {
"amount": 0,
"currency": "SAR",
"count": 0
}
},
"links": {},
"meta": {}
}
]
}Response parameters
Parameter | Description |
|---|---|
success | Process success status represented as |
payload | Payload tag carrying response information |
code | Unique bank code identification |
data | Tag carrying accounts and Direct Debits data included in the response |
accountId | Unique account identification |
directDebit | Tag carrying information on Direct Debits for the account |
directDebitId | Unique Direct Debit identification |
mandateIdentification | Unique mandate identification details |
directDebitStatusCode | Status code of the Direct Debit |
name | Registered name of the Direct Debit |
previousPaymentDateTime | Date and time of the previous Direct Debit payment |
frequency | Frequency of the payment |
previousPaymentAmount | Amount paid for the last (previous) Direct Debit payment |
amount | Transaction amount for the previous direct debit payment |
currency | Default currency of the account in which the transaction amount is indicated |
currentMonthPaid | Amount paid for the current month's Direct Debit payment |
amount | Transaction amount for the previous direct debit payment |
currency | Default currency of the account in which the transaction amount is indicated |
count | Total count of payments towards the direct debit |
links | Redirect link |
self | Own link/URL details |
meta | Meta tag |
totalPages | Information displayed in terms of pages |