Post Bank Balances

POST

/public/v3/customers/{customer_id}/balance_collections

Creates bank Account Balances. You need to create Bank Accounts before using this endpoint

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
balancesArrayyesArray of balances
amountfloatyesAmount (positive for income and negative for expenditure)
currencystringyesCurrency code (compatible with ISO 4217)
bank_slugstringyesSlug of the associated bank
account_numberstringyesNumber of the associated account
date_timeintegeryesTimestamp
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 curl --location --request POST 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/balance_collections' --header 'Content-Type: application/json' --header 'Authorization: Bearer {access_token}' --data-raw '{ "balances": [ { "amount": 13268.28, "currency": "GBP", "bank_slug": "barclays", "account_number": "123-123-123-123", "date_time": "1584524622", "type": "ClosingBooked" } ] }

Response example:

1 2 3 { "status": "success" }

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)