Skip to main content
POST
/
v3
/
{customerId}
/
BankingServices
/
GetStatements
Get Statements
curl --request POST \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices/GetStatements \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "HttpStatusCode": 200,
  "StatementsByAccount": [
    {
      "AccountNumber": "1111000",
      "Statements": [
        {
          "UniqueId": "3DD209E106553D2BB0A6EFF57FD0480C",
          "FileType": "PDF",
          "Base64Bytes": "..."
        }
      ]
    }
  ],
  "Login": {
    "Username": "Greatday",
    "IsScheduledRefresh": false,
    "LastRefresh": "2019-05-17T15:29:23.7035672",
    "Type": "Personal",
    "Id": "34c85a5d-f278-467b-29ed-08d682e1fef5"
  },
  "Institution": "FlinksCapital",
  "RequestId": "f56f8b80-9949-4c60-ad63-dcdc0fd1456b"
}
To retrieve PDF statements from a customer’s financial institution, use the /GetStatements endpoint. You must first call the /Authorize endpoint to get a valid RequestId.

This endpoint is only available to clients who are based in Canada

If you are based in Canada and want to use this feature, contact your Flinks Representative and we will enable it for you in your private instance.

Add the Flinks Connect parameter to your iframe URL before calling this endpoint

To retrieve statements successfully, you must add the Flinks Connect parameter detailsAndStatementEnable=true to your iframe URL.

Headers

​
x-api-key
string

Security feature that grants access to this endpoint.

Path Parameters

​
customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

Key that grants access to the environment.

Body

application/json
​
RequestId
string
required

Unique identifier provided after a successful request to the /Authorize endpoint.

​
NumberOfStatements
enum<string>
default:MostRecent

Number of PDF banking statements that are returned per customer account.

Available options:
MostRecent,
Months3,
Months12
​
AccountsFilter
string[]

You can include the AccountsFilter parameter in the request body.

Response

Success

​
HttpStatusCode
integer
​
StatementsByAccount
object[]

Array containing statements organized by account.

​
Login
object

Login information.

​
Institution
string
​
RequestId
string