Get Transactions

GET

/public/v3/customers/{customer_id}/transactions

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID

Query parameters

ParameterData typeRequired?Description
pageintegernoPage number (1 by default)
max_per_pageintegernoItem count on one page (1000 by default)
bank_slugstringnoFilter by bank slug
account_numberstringnoFilter by account number
account_typestringnoFilter by account type. Account type can be ('Personal' or 'Business')
category_idstringnoFilter by specific Category
currencystringnoFilter by Currency (ISO 4217 format)
booking_date_time_fromintegernoMin value (inclusive) for booking date time filter (UNIX timestamp in seconds)
booking_date_time_tointegernoMax value (inclusive) for booking date time filter (UNIX timestamp in seconds)

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
idstringyesTransaction ID
external_transaction_idstringyesTransaction ID from the original data source. Must be unique for associated customer and bank account.
namestringyesTransaction name or description
typestringnoTransaction type, if available
amountfloatyesAmount of associated currency (positive for income and negative for expenditure)
balanceBalanceyesTransaction Balance ocject
currencystringyesCurrency code (compatible with ISO 4217)
statusstringyesAllowed:(Booked, Pending)
bank_slugstringyesSlug of the associated bank
account_numberstringyesAccount number (Includes account number and sort code)
categorystringnoCategory of the transaction
category_typestringnoCategory type
address_linestringnoAddress line
merchant_detailsMerchant DetailsnoDetails of the merchant involved in the transaction
proprietary_bank_transaction_codeProprietary Bank Transaction CodenoSet of elements to fully identify a proprietary bank transaction code.
value_date_timeintegeryesTimestamp of value date and time
booking_date_timeintegeryesTimestamp of booking date and time

Balance

ParameterData typeRequired?Description
amountfloatyesAmount (positive for income and negative for expenditure)
currencystringyesCurrency code (compatible with ISO 4217)
typeenumyesAllowed:(ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked)

Merchant Details

ParameterData typeRequired?Description
merchant_namestringnoName by which the merchant is known.
merchant_category_codestringnoCategory code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

Proprietary Bank Transaction Code

ParameterData typeRequired?Description
codestringnoProprietary bank transaction code to identify the underlying transaction.
issuerstringnoIdentification of the issuer of the proprietary bank transaction code.

Request example

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}'

Response example:

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.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

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: 781963)