Skip to main content
Get Accounts
curl --request GET \
  --url https://api.yapily.com/accounts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'consent: <consent>'
{
  "meta": {
    "tracingId": "1139346006be4345a94fd8b3728844e3",
    "count": 1
  },
  "data": [
    {
      "id": "700004000000000000000002",
      "type": "Personal - Current",
      "balance": -12.57,
      "currency": "GBP",
      "usageType": "PERSONAL",
      "accountType": "CURRENT",
      "nickname": "xxxx0006",
      "accountNames": [
        {
          "name": "Mr. Roberto Rastapopoulos & Ivan Sakharine"
        }
      ],
      "accountIdentifications": [
        {
          "type": "SORT_CODE",
          "identification": "700001"
        },
        {
          "type": "ACCOUNT_NUMBER",
          "identification": "70000002"
        }
      ],
      "accountBalances": [
        {
          "type": "EXPECTED",
          "dateTime": "2021-06-09T08:51:02.463Z",
          "balanceAmount": {
            "amount": -12.57,
            "currency": "GBP"
          },
          "creditLineIncluded": false,
          "creditLines": []
        }
      ]
    }
  ]
}
Learn more: Balance Types

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

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

Response

Ok

meta
object
data
object[]
forwardedData
object[]
raw
object[]
deprecated
paging
object