YAyapily
Financial Data

Get Account Balances

Returns the balance for the end user associated with the presented consent token.

Feature: ACCOUNT_BALANCES

get/accounts/{accountId}/balances

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Path parameters

accountIdstring required

Mandatory. The account Id of the user's bank account.

Headers

consentstring required

Mandatory. The consent-token containing the user's authorisation to make the request.

psu-idstring

Conditional. Represents the user's login ID for the Institution to a personal account.

See PSU identifiers to see if this header is required.

psu-corporate-idstring

Conditional. Represents the user's login ID for the Institution to a business account.

See PSU identifiers to see if this header is required.

psu-ip-addressstring

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

sub-applicationstring uuid

The sub-application ID to which event type is being subscribed to

Response

Ok

linksobject
tracingIdstring

Example response

{
  "data": {
    "mainBalanceAmount": {
      "amount": 10,
      "currency": "GBP"
    },
    "balances": [
      {
        "balanceAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "creditLines": [
          {
            "creditLineAmount": {
              "amount": 10,
              "currency": "GBP"
            }
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.