Post Bank Transactions

POST

/public/v3/customers/{customer_id}/transaction_collections

Creates bank Account Transactions. You need to create Bank Accounts before using this endpoint. You can submit up to 10 000 transactions at once. Transactions has to have unique external_transaction_id.

Please obtain the right bank_slug from Banks endpoint

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID

Query parameters

none

Request Body Parameters

ParameterData typeRequired?Description
transactionsArrayyesArray of transactions
external_transaction_idstringyesTransaction ID from the original data source. Must be unique for associated user and account.
namestringnoTransaction name or description
typestringnoTransaction type, if available
amountfloatyesAmount (positive for income and negative for expenditure)
balanceBalancenoBalance object
currencystringyesCurrency code (compatible with ISO 4217)
statusenumyesAllowed:(Booked, Pending)
bank_slugstringyesSlug of the associated bank
account_numberstringyesNumber of the associated account
categorystringnoCategory of the transaction
address_linestringnoAddress line
value_date_timeintegeryesTimestamp
booking_date_timeintegeryesTimestamp

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)

Response Body Parameters

ParameterData typeRequired?Description
processing_statusstringyesAllowed: (failed, in_progress, finished)
dtn_slugstringyesSlug that you can use in Utils endpoints to determine if the process has finished.
updated_attimestampyesTimestamp of the operation

Request example

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 curl --location --request POST 'https://api.friendlyscore.com/public/v3/customers/123/transaction_collections' --header 'Content-Type: application/json' --data-raw '{ "transactions": [ { "external_transaction_id": "958d14298-91ee-405d-89da-248c30eaf0e81-booked", "name": "TFL TRAVEL ON 25 NOV Booked", "type": "", "amount": -255, "currency": "GBP", "status": "Booked", "bank_slug": "barclays", "account_number": "123-123-123-123", "balance": { "amount": -105, "currency": "GBP", "type": "ClosingAvailable" }, "booking_date_time": 1574672448 }] }'

Response example:

1 2 3 4 5 { "updated_at": 1627391420, "processing_status": "in_progress", "dtn_slug": "abc-123" }

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)