Skip to main content
Get Account Balances
curl --request GET \
  --url https://api.yapily.com/accounts/{accountId}/balances \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'consent: <consent>'
{
  "meta": {
    "tracingId": "82e86ae9547a4f04b3773c1207e4b84d"
  },
  "data": {
    "mainBalanceAmount": {
      "amount": -3079208604.11,
      "currency": "EUR"
    },
    "balances": [
      {
        "type": "INTERIM_AVAILABLE",
        "balanceAmount": {
          "amount": -3079208604.11,
          "currency": "EUR"
        }
      },
      {
        "type": "AUTHORISED",
        "balanceAmount": {
          "amount": -3079208604.11,
          "currency": "EUR"
        }
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yapily.com/llms.txt

Use this file to discover all available pages before exploring further.

Learn more: Balance Types explained

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

​
consent
string
required

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

​
psu-id
string

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-id
string

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-address
string

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

​
sub-application
string<uuid>

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

Path Parameters

​
accountId
string
required

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

Response

Ok

​
meta
object
​
data
object
​
links
object
​
forwardedData
object[]
​
raw
object[]
deprecated