Get Transactions
GET
/public/v3/customers/{customer_id}/transactions
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| page | integer | no | Page number (1 by default) |
| max_per_page | integer | no | Item count on one page (1000 by default) |
| bank_slug | string | no | Filter by bank slug |
| account_number | string | no | Filter by account number |
| account_type | string | no | Filter by account type. Account type can be ('Personal' or 'Business') |
| category_id | string | no | Filter by specific Category |
| currency | string | no | Filter by Currency (ISO 4217 format) |
| booking_date_time_from | integer | no | Min value (inclusive) for booking date time filter (UNIX timestamp in seconds) |
| booking_date_time_to | integer | no | Max value (inclusive) for booking date time filter (UNIX timestamp in seconds) |
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| id | string | yes | Transaction ID |
| external_transaction_id | string | no | Transaction ID from the original data source. Must be unique for associated customer and bank account. |
| name | string | yes | Transaction name or description |
| type | string | no | Transaction type, if available |
| amount | float | yes | Amount of associated currency (positive for income and negative for expenditure) |
| balance | Balance | yes | Transaction Balance ocject |
| currency | string | yes | Currency code (compatible with ISO 4217) |
| status | string | yes | Allowed:(Booked, Pending) |
| bank_slug | string | yes | Slug of the associated bank |
| account_number | string | yes | Account number (Includes account number and sort code) |
| category | string | no | Category of the transaction |
| category_type | string | no | Category type |
| address_line | string | no | Address line |
| merchant_details | Merchant Details | no | Details of the merchant involved in the transaction |
| proprietary_bank_transaction_code | Proprietary Bank Transaction Code | no | Set of elements to fully identify a proprietary bank transaction code. |
| value_date_time | integer | yes | Timestamp of value date and time |
| booking_date_time | integer | yes | Timestamp of booking date and time |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| amount | float | yes | Amount (positive for income and negative for expenditure) |
| currency | string | yes | Currency code (compatible with ISO 4217) |
| type | enum | yes | Allowed:(ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked) |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| merchant_name | string | no | Name by which the merchant is known. |
| merchant_category_code | string | no | Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| code | string | no | Proprietary bank transaction code to identify the underlying transaction. |
| issuer | string | no | Identification of the issuer of the proprietary bank transaction code. |
1
2
3
curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/transactions' \
--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
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
"data": [
{
"id": "123",
"external_transaction_id": "123",
"name": "Granny's Bakery",
"type": "optional_type_description",
"amount": "22.35",
"balance": {
"amount": "22.35",
"currency": "GBP",
"type": "ClosingBooked",
"custom_data": {}
},
"currency": "GBP",
"status": "Booked",
"bank_slug": "barclays",
"account_number": "123-123-123-123",
"category": "Groceries & Supplies",
"category_type": "fixed",
"address_line": "1234 Some Address, London",
"value_date_time": "1553077496",
"booking_date_time": "1553077496",
"custom_data": {},
"merchant_details": {
"merchant_name": "abc",
"merchant_category_code": "5999"
},
"proprietary_bank_transaction_code": {
"issuer": "abc",
"code": "abc"
}
}
]
}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)