Balance

Get information on account balance

Get Account Balance by Account ID

This method retrieves the specific account balances by using the account ID included in the request.

Endpoint details

Endpoint URL

Method

Authentication requirements

/v1/api/observice/balanceById

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": "Bank_Code",
      "data": {
        "accountId": "Account_Id",
        "balance": [
          {
            "amount": {
              "amount": "0000.00",
              "currency": "Currency"
            },
            "creditDebitIndicator": "Credit_or_Debit",
            "type": "Type_Indicator",
            "dateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
            "creditLine": [
              {
                "included": true,
                "type": "Credit_Line_Type",
                "amount": {
                  "amount": "0000.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 account and balance data included in the response
accountIdUnique account identification
balanceTag carrying account balance information
amountTag carrying cash balance information
amountCash balance amount
currencyDefault currency of the account in which the balance is indicated
creditDebitIndicatorIndicates whether the balance is a credit or a debit balance
typeIndicator type details
dateTimeDate and time information of the indicator
creditLineTag carrying credit line information
includedStatus of credit line as included or excluded
typeType of credit line details
amountTag carrying amount information of credit line
amountAvailable amount in credit line
currencyCurrency in which the credit line balance is indicated
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation displayed in terms of pages