Get Balances
GET
/public/v3/customers/{customer_id}/balances
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
none
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| id | string | yes | Balance ID |
| amount | float | yes | Amount of associated currency (positive for income and negative for expenditure) |
| currency | string | yes | Currency code (compatible with ISO 4217) |
| type | string | yes | Allowed:(ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared) |
| bank_slug | string | yes | Slug of the associated bank |
| account_number | string | yes | Number of the associated account |
| date_time | integer | yes | date and time in timestamp format |
| credit_line | Credit Line | no | Credit Line |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| amount | string | no | Credit line amount |
| type | string | no | Credit line type |
1
2
3
curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/balances' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": [
{
"id": "123456",
"amount": "22.35",
"currency": "GBP",
"type": "ClosingBooked",
"custom_data": {},
"bank_slug": "barclays",
"account_number": "123-123-123-123",
"date_time": "1553077496",
"credit_line": [
{
"type": "Pre-Agreed",
"amount": "4500.00"
}
]
}
]
}Was this article helpful?
Friendly Score UK Ltd.
84 Brook Street
London W1K 5EH
Call us on +44 20 3709 6726
Company registered in England
Company number 09168668, ICO ZA111687
VAT registration number 206 9758 80
Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)