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. clientId
2. clientCode
3. signature
4. Authorization Bearer: Token

Sample request

{
  "dateTimeStamp": "2024-12-31T10:40:00+02:00",
  "requestID": "df797efb-b588-4234-8ae1-5cb748559830",
  "merchantId": "APIS-300505",
  "banks": [
    {
      "code": "SAMA",
      "consentId":"urn:SAMA:kac-5a166b7d-8cdb-443a-a67a-80ad7a5b95b3",
      "accountId": "100004000000000000000002"
    }
  ]
}

Request description

JSON Tag

Description

Data type

DateTimeStamp Mandatory

Stamp denoting the date and time of the request
ISO 8601 format - YYYY-MM-DDTHH:MM:SS

Date

RequestID
Mandatory

Unique request identification
UUID format

Alphanumeric

merchantId
Mandatory

Unique merchant identification
UUID format

Alphanumeric

banks
Mandatory

Array of banks and consents

Object

code
Mandatory

Unique bank identification code

Alphanumeric

consentId
Mandatory

Unique consent identification

String

accountId
Mandatory

Unique account identification as per the consent

String

Sample response

{
  "success": true,
  "payload": [
    {
      "code": "ALINMA",
      "data": {
        "accountId": "100004000000000000000002",
        "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"
            }
          },
          {
            "directDebitId": "001000000000000000000122",
            "mandateIdentification": "37101310109",
            "directDebitStatusCode": "Active",
            "name": "AMERICAN EXPRESS",
            "previousPaymentDateTime": "2017-11-20T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "2583.46",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000123",
            "mandateIdentification": "727380302001",
            "directDebitStatusCode": "Active",
            "name": "VIRGIN MEDIA PYMTS",
            "previousPaymentDateTime": "2017-11-20T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "82.48",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000124",
            "mandateIdentification": "A319834ER",
            "directDebitStatusCode": "Active",
            "name": "AVIVA LIFE",
            "previousPaymentDateTime": "2017-11-15T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "40.32",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000125",
            "mandateIdentification": "A319879ED",
            "directDebitStatusCode": "Active",
            "name": "AVIVA LIFE",
            "previousPaymentDateTime": "2017-11-15T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "17.84",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000126",
            "mandateIdentification": "A325453EZ",
            "directDebitStatusCode": "Active",
            "name": "AVIVA LIFE",
            "previousPaymentDateTime": "2017-11-15T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "63.20",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000127",
            "mandateIdentification": "5000007799272500",
            "directDebitStatusCode": "Active",
            "name": "LLOYDS BANK MTG",
            "previousPaymentDateTime": "2017-11-15T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "200.65",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000128",
            "mandateIdentification": "364417",
            "directDebitStatusCode": "Active",
            "name": "HONDA FINANCE GBPO",
            "previousPaymentDateTime": "2017-11-13T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "8266.01",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000129",
            "mandateIdentification": "401203101401",
            "directDebitStatusCode": "Active",
            "name": "RMG CRA",
            "previousPaymentDateTime": "2017-11-06T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "119.07",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000130",
            "mandateIdentification": "5522139602499925",
            "directDebitStatusCode": "Inactive",
            "name": "NW WORLD MASTERCAR",
            "previousPaymentDateTime": "2017-10-23T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "891.62",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "001000000000000000000131",
            "mandateIdentification": "9189963",
            "directDebitStatusCode": "Active",
            "name": "DVLA-LS64XYZ",
            "previousPaymentDateTime": "2017-10-03T00:00:00.000Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "190.00",
              "currency": "SAR"
            }
          },
          {
            "directDebitId": "1a5643e0-0fa3-4079-8778-f70abb0f465a",
            "mandateIdentification": "pfYphPYG8A",
            "directDebitStatusCode": "Active",
            "name": "Almutlaq Holding",
            "previousPaymentDateTime": "2022-12-24T22:21:09.453Z",
            "frequency": "KSAOB.Annual",
            "previousPaymentAmount": {
              "amount": "48.16",
              "currency": "SAR"
            }
          }
        ]
      },
      "links": {
        "self": "https://rs-ob-sb.alinma.com/open-banking/account-information/2022.11.01-final-errata2/accounts/100004000000000000000002/direct-debits"
      },
      "meta": {
        "totalPages": 1
      }
    }
  ]
}

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