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 URLMethodAuthentication requirements
/v1/api/observice/directDebitsByIdPOST1. clientId 2. clientCode 3. signature 4. 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 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