Get Statements

GET

/public/v3/customers/{customer_id}/accounts/{account_id}/statements

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID
account_idstringyesAccount ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
AccountIdstringyesAccount ID
StatementIdstringyesStatement ID
StatementReferencestringnoStatement Reference
TypestringnoType
StartDateTimestringnoStart Date Time
EndDateTimestringnoEnd Date Time
CreationDateTimestringnoCreation Date Time
StatementDescriptionArray<string>noStatement Descriptions
StatementFeeStatement FeenoStatementFee Object
StatementInterestStatement InterestnoStatementInterest Object
StatementRateStatement RatenoStatementRate Object
StatementValueStatement ValuenoStatementValue Object
StatementDateTimesStatement Date TimenoStatementDateTimes Object
StatementAmountsStatement AmountnoStatementAmounts Object
StatementBenefitsStatement BenefitnoStatementBenefits Object

Statement Fee

ParameterData typeRequired?Description
DescriptionArray<string>noDescriptions
CreditDebitIndicatorstringnoCredit Debit Indicator
TypestringnoType
RatedoublenoRate
RateTypestringnoRate Type
FrequencystringnoFrequency
AmountstringnoAmount
CurrencystringnoCurrency

Statement Interest

ParameterData typeRequired?Description
DescriptionArray<string>noDescriptions
CreditDebitIndicatorstringnoCredit Debit Indicator
TypestringnoType
RatedoublenoRate
RateTypestringnoRate Type
FrequencystringnoFrequency
AmountstringnoAmount
CurrencystringnoCurrency

Statement Rate

ParameterData typeRequired?Description
TypestringnoType
RatedoublenoRate

Statement Value

ParameterData typeRequired?Description
TypestringnoType
RatedoublenoRate

Statement Date Time

ParameterData typeRequired?Description
TypestringnoType
DateTimestringnoDate Time

Statement Amount

ParameterData typeRequired?Description
CreditDebitIndicatorstringnoCredit Debit Indicator
TypestringnoType
AmountstringnoAmount
CurrencystringnoCurrency

Statement Benefit

ParameterData typeRequired?Description
TypestringnoType
AmountstringnoAmount
CurrencystringnoCurrency

Request example

1 curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/account/{account_id}/statements'

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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 { "data": [ { "AccountId": "123", "StatementId": "123", "StatementReference": "123", "Type": "123", "StartDateTime": "123", "EndDateTime": "123", "CreationDateTime": "123", "StatementDescription": "['description 1', 'description 2']", "StatementFee": [ { "Description": "['description 1', 'description 2']", "CreditDebitIndicator": "123", "Type": "123", "Rate": "123.23", "RateType": "123", "Frequency": "123", "Amount": "50.23", "Currency": "GBP" } ], "StatementInterest": [ { "Description": "['description 1', 'description 2']", "CreditDebitIndicator": "123", "Type": "123", "Rate": "123.23", "RateType": "123", "Frequency": "123", "Amount": "50.23", "Currency": "GBP" } ], "StatementRate": [ { "Rate": "123", "Type": "123" } ], "StatementValue": [ { "Value": "123", "Type": "123" } ], "StatementDateTimes": [ { "Type": "123", "DateTime": "123" } ], "StatementAmounts": [ { "CreditDebitIndicator": "123", "Type": "123", "Amount": "50.23", "Currency": "GBP" } ], "StatementBenefits": [ { "Type": "123", "Amount": "50.23", "Currency": "GBP" } ] } ] }

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)