Direct Debits
Retrieve information on direct debits of a bank account
Get Account's Direct Debits by Account ID
This method fetches the Direct Debit details of the specified account through the Account ID included in the provided the Consent ID.
Endpoint details
| Endpoint URL | Method | Authentication requirements |
|---|---|---|
/v1/api/observice/directDebitsById | POST | 1. clientId2. clientCode3. signature4. Authorization Bearer: Token |
Sample request
{
"dateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
"requestID": "Enter_Request_Id",
"merchantId": "Enter_Merchant_Id",
"banks": [
{
"code": "Enter_Bank_Code",
"consentId":"Enter_Consent_Id",
"accountId": "Enter_Account_Id"
}
]
}
Request description
| JSON Tag | Description | Data type |
|---|---|---|
| DateTimeStamp Mandatory | Stamp denoting the date and time of the request | String |
| RequestID Mandatory | Unique request identification | String |
| merchantId Mandatory | Unique merchant identification | String |
| banks Mandatory | Array of banks and consents | Object |
| code Mandatory | Unique bank identification code | String |
| consentId Mandatory | Unique consent identification | String |
| accountId Mandatory | Unique account identification as per the consent | String |
Sample response
{
"success": true,
"payload": [
{
"code": "Bank_Code",
"data": {
"accountId": "Account_Id",
"directDebit": [
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
},
{
"directDebitId": "Direct_Debit_Id",
"mandateIdentification": "Unique_Identification_for_Mandate",
"directDebitStatusCode": "Status_Code",
"name": "Name of the party",
"previousPaymentDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"frequency": "Frequency",
"previousPaymentAmount": {
"amount": "000.00",
"currency": "Currency"
}
}
]
},
"links": {
"self": "https://"
},
"meta": {
"totalPages": 0
}
}
]
}
Response description
| JSON Tag | Description |
|---|---|
| success | Process success status represented as True or False |
| 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 |
| links | Redirect link |
| self | Own link/URL details |
| meta | Meta tag |
| totalPages | Information displayed in terms of pages |
Updated 2 months ago