API reference Balances

Balances

On this page:

GET[base]/accounts/{accountId}/balances

Get a list of balances

Use this method to obtain a balance of a specified account that the PSU has authorized to access.

Request

Header parameters:

Authorization: The authorization token as per https://tools.ietf.org/html/rfc6750.
x-fapi-financial-id required: The unique identifier of the ASPSP issued by the Open Banking system.
x-fapi-customer-last-logged-time: The date and time when the PSU has last logged in system using a TPP application.
x-fapi-customer-ip-address: The IP address of the PSU who has logged in system using the TPP application.
x-fapi-interaction-id: The unique identifier of the initiating party (as per RFC4122 UID) used as a correlation identifier.
x-customer-user-agent: The user-agent used by the PSU.

Path parameters:

AccountId required: The account identifier.

GET[base]/accounts/{accountId}/balances

GET /accounts/account-id-example/balances HTTP/1.1
Authorization: Bearer <token>
x-fapi-financial-id: b621cec4-e775-49ab-980a-1900c6a09620
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Response

Body:

Balance object

This object provides the following data:

Expand fields

AccountId string

The account identifier.

CreditDebitIndicator string

Indicates whether the balance is credit or debit. A zero balance is considered to be a credit balance.

Possible values:

Credit
Debit

Type string

The balance type. Possible values:

ClosingAvailable
ClosingBooked
ClosingCleared
Expected
ForwardAvailable
Information
InterimAvailable
InterimBooked
InterimCleared
OpeningAvailable
OpeningBooked
OpeningCleared
PreviouslyClosedBooked

DateTime string

The date and time when the balance is generated.

Amount string

The amount of money of the cash balance after a transaction entry is applied to an account.

Currency string

The currency of an account as per ISO 4217.

CreditLine object

This object provides the following data:

Expand fields

Included boolean: If true, the credit line is included in the balance of the account; otherwise, false.
Type string: The limit type. Possible values:

Available
Credit
Emergency
Pre-Agreed
Temporary

Amount string: The amount of money of the cash balance after a transaction entry is applied to an account.
Currency string: The currency of an account as per ISO 4217.

HTTP status codes:

The eqwire API uses standard HTTP response codes to indicate the success or failure of a request.

To view a full list of valid response codes, refer to HTTP response codes.

    RESPONSE EXAMPLE
  
{
    "Data": {
      "Balance": [
        {
          "AccountId": "22289",
          "CreditDebitIndicator": "Credit",
          "Type": "ClosingAvailable",
          "DateTime": "2022-12-05T06:21:46.451Z",
          "Amount": {
            "Amount": "1230.00",
            "Currency": "GBP"
          },
          "CreditLine": [
            {
              "Included": true,
              "Type": "Available",
              "Amount": {
                "Amount": "1000.00",
                "Currency": "GBP"
              }
            }
          ]
        }
      ]
    },
    "Links": {
      "Self": "https://example.com",
      "First": "https://example.com",
      "Prev": "https://example.com",
      "Next": "https://example.com",
      "Last": "https://example.com"
    },
    "Meta": {
      "TotalPages": 5,
      "FirstAvailableDateTime": "2022-12-05T06:21:46.451Z",
      "LastAvailableDateTime": "2022-12-05T06:21:46.451Z"
    }
  }