Direct Debits
Retrieve information on direct debits of a single or multiple accounts
Get All Accounts' Direct Debits
This method fetches all the direct debits associated with the all the accounts included in the provided Consent ID.
Endpoint details
Endpoint URL | Method | Grant type | Scope |
---|---|---|---|
/v1/api/observice/allAccountsDirectDebits | POST | The header should include: 1. signature 2. Authorization: Bearer Token | Fetch Direct Debits' information of all the accounts included in the specified Consent ID |
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"
}
]
}
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 |
Sample response
{
"success": true,
"payload": [
{
"code": "Bank_Code",
"data": {
"account": [
{
"accountId": "Account_Id",
"accountHolderName": "Account_Holder_Name",
"accountHolderShortName": "Account_Holder_Short_Name",
"status": "Account_Status",
"currency": "Currency",
"nickname": "Account_Nickname",
"accountType": "Account_Type",
"accountSubType": "Account_Sub_Type",
"accountIdentifiers": [
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
},
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
}
],
"servicer": {
"identificationType": "Servicer_Identification_Type",
"identification": "Servicer_Identification"
},
"statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"description": "Account_Description",
"openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"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"
}
}
]
},
{
"accountId": "Account_Id",
"accountHolderName": "Account_Holder_Name",
"accountHolderShortName": "Account_Holder_Short_Name",
"status": "Account_Status",
"currency": "Currency",
"nickname": "Account_Nickname",
"accountType": "Account_Type",
"accountSubType": "Account_Sub_Type",
"accountIdentifiers": [
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
},
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
}
],
"servicer": {
"identificationType": "Servicer_Identification_Type",
"identification": "Servicer_Identification"
},
"statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"description": "Account_Description",
"openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"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"
}
}
]
},
],
"currentMonthPaid": {
"amount": 000,
"currency": "Currency",
"count": 0
}
},
"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 |
account | Tag carrying response information categorized for individual accounts included in the consent ID |
accountId | Unique account identification |
accountHolderName | Name of the account holder |
accountHolderShortName | Short name of the account holder |
status | Status of the account |
currency | Default currency of the account |
nickname | Nickname of the account |
accountType | Details of account type |
accountSubType | Details of account sub-type |
accountIdentifiers | Tag carrying account identifiers details |
identificationType | Account identification type details |
identification | Account identification details |
name | Name of the account identifier |
servicer | Tag carrying account servicer details |
identificationType | Servicer identification type details |
identification | Servicer identification details |
statusUpdateDateTime | Last time and date of update for account information |
description | Description of the update |
openingDate | Opening date of the account |
maturityDate | Maturity date of the account |
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 | Tag carrying details on the amount paid for Direct Debits for the existing month |
amount | Total amount paid in the current month |
currency | Currency in which the amount is indicated |
count | Number of Direct Debits paid in the current month |
links | Redirect link |
self | Own link/URL details |
meta | Meta tag |
totalPages | Information displayed in terms of pages |
Get Account's Direct Debits by Account ID
This method fetches the Direct Debit details of the specified account through Account ID included in the provided Consent ID.
Endpoint details
Endpoint URL | Method | Grant type | Scope |
---|---|---|---|
/v1/api/observice/directDebitsById | POST | The header should include: 1. signature 2. Authorization: Bearer Token | Fetch Direct Debits' information of the specified account using Account ID |
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 4 days ago