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 URLMethodGrant typeScope
/v1/api/observice/allAccountsDirectDebitsPOSTThe 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 TagDescriptionData type
DateTimeStamp
Mandatory
Stamp denoting the date and time of the requestString
RequestID
Mandatory
Unique request identificationString
merchantId
Mandatory
Unique merchant identificationString
banks
Mandatory
Array of banks and consentsObject
code
Mandatory
Unique bank identification codeString
consentId
Mandatory
Unique consent identificationString

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 TagDescription
successProcess success status represented as True or False
payloadPayload tag carrying response information
codeUnique bank code identification
dataTag carrying accounts and Direct Debits data included in the response
accountTag carrying response information categorized for individual accounts included in the consent ID
accountIdUnique account identification
accountHolderNameName of the account holder
accountHolderShortNameShort name of the account holder
statusStatus of the account
currencyDefault currency of the account
nicknameNickname of the account
accountTypeDetails of account type
accountSubTypeDetails of account sub-type
accountIdentifiersTag carrying account identifiers details
identificationTypeAccount identification type details
identificationAccount identification details
nameName of the account identifier
servicerTag carrying account servicer details
identificationTypeServicer identification type details
identificationServicer identification details
statusUpdateDateTimeLast time and date of update for account information
descriptionDescription of the update
openingDateOpening date of the account
maturityDateMaturity date of the account
directDebitTag carrying information on Direct Debits for the account
directDebitIdUnique Direct Debit identification
mandateIdentificationUnique mandate identification details
directDebitStatusCodeStatus code of the Direct Debit
nameRegistered name of the Direct Debit
previousPaymentDateTimeDate and time of the previous Direct Debit payment
frequencyFrequency of the payment
previousPaymentAmountAmount paid for the last (previous) Direct Debit payment
amountTransaction amount for the previous direct debit payment
currencyDefault currency of the account in which the transaction amount is indicated
currentMonthPaidTag carrying details on the amount paid for Direct Debits for the existing month
amountTotal amount paid in the current month
currencyCurrency in which the amount is indicated
countNumber of Direct Debits paid in the current month
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation 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 URLMethodGrant typeScope
/v1/api/observice/directDebitsByIdPOSTThe 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 TagDescriptionData type
DateTimeStamp
Mandatory
Stamp denoting the date and time of the requestString
RequestID
Mandatory
Unique request identificationString
merchantId
Mandatory
Unique merchant identificationString
banks
Mandatory
Array of banks and consentsObject
code
Mandatory
Unique bank identification codeString
consentId
Mandatory
Unique consent identificationString
accountId
Mandatory
Unique account identification as per the consentString

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 TagDescription
successProcess success status represented as True or False
payloadPayload tag carrying response information
codeUnique bank code identification
dataTag carrying accounts and Direct Debits data included in the response
accountIdUnique account identification
directDebitTag carrying information on Direct Debits for the account
directDebitIdUnique Direct Debit identification
mandateIdentificationUnique mandate identification details
directDebitStatusCodeStatus code of the Direct Debit
nameRegistered name of the Direct Debit
previousPaymentDateTimeDate and time of the previous Direct Debit payment
frequencyFrequency of the payment
previousPaymentAmountAmount paid for the last (previous) Direct Debit payment
amountTransaction amount for the previous direct debit payment
currencyDefault currency of the account in which the transaction amount is indicated
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation displayed in terms of pages