Get Statements

Get Statements

curl --request GET \
  --url https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "page": {
    "nextOffset": "97fcd39f-6e32-470b-a107-d4cb1080abcc",
    "totalElements": 12
  },
  "links": {
    "next": {
      "href": "https://ob-preprod.flinksapp.dev/api/fdx/5/accounts/11/statements?startTime=2025-01-01&endTime=2025-12-31&limit=2&offset=97fcd39f-6e32-470b-a107-d4cb1080abcc"
    }
  },
  "statements": [
    {
      "accountId": "11",
      "statementId": "20001",
      "statementDate": "2025-12-31",
      "description": "December 2025 statement",
      "status": "AVAILABLE"
    },
    {
      "accountId": "11",
      "statementId": "20002",
      "statementDate": "2025-11-30",
      "description": "November 2025 statement",
      "status": "PROCESSING"
    }
  ]
}

{
  "statements": [
    {
      "accountId": "11",
      "statementId": "20012",
      "statementDate": "2025-01-31",
      "description": "January 2025 statement",
      "status": "AVAILABLE"
    }
  ]
}

{
  "code": 702,
  "message": "Invalid start or end date",
  "debugMessage": "Start time is invalid"
}

{
  "code": 500,
  "message": "Internal Server Error",
  "debugMessage": "An unexpected error occured"
}

GET

api

fdx

accounts

{account_id}

statements

Get Statements

curl --request GET \
  --url https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ob.flinksapp.com/api/fdx/5/accounts/{account_id}/statements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "page": {
    "nextOffset": "97fcd39f-6e32-470b-a107-d4cb1080abcc",
    "totalElements": 12
  },
  "links": {
    "next": {
      "href": "https://ob-preprod.flinksapp.dev/api/fdx/5/accounts/11/statements?startTime=2025-01-01&endTime=2025-12-31&limit=2&offset=97fcd39f-6e32-470b-a107-d4cb1080abcc"
    }
  },
  "statements": [
    {
      "accountId": "11",
      "statementId": "20001",
      "statementDate": "2025-12-31",
      "description": "December 2025 statement",
      "status": "AVAILABLE"
    },
    {
      "accountId": "11",
      "statementId": "20002",
      "statementDate": "2025-11-30",
      "description": "November 2025 statement",
      "status": "PROCESSING"
    }
  ]
}

{
  "statements": [
    {
      "accountId": "11",
      "statementId": "20012",
      "statementDate": "2025-01-31",
      "description": "January 2025 statement",
      "status": "AVAILABLE"
    }
  ]
}

{
  "code": 702,
  "message": "Invalid start or end date",
  "debugMessage": "Start time is invalid"
}

{
  "code": 500,
  "message": "Internal Server Error",
  "debugMessage": "An unexpected error occured"
}

Use the /api/fdx/5/accounts/{accountId}/statements endpoint to get a paginated list of the statements available for a particular account. Use the statementId from the response to call Download Statement. To successfully call this endpoint, you must first call the /Token endpoint to obtain a valid access_token using:

grant_type: authorization_code or refresh_token
client_id: {recipient client_id}
client_secret: {recipient client_secret}
redirect_uri: {recipient redirect_uri}
code: {with grant type authorization_code}
refresh_token: {with grant type refresh_token}

Filter and paginate results

Use startTime and endTime (YYYY-MM-DD) to limit the statements to a date range. If you provide one, you must provide both, and startTime must not be after endTime. Otherwise you’ll receive error 702 or 703. A date that isn’t in YYYY-MM-DD format returns error 401 (Invalid Input). If you omit both dates, the Data Provider applies a default date range, which varies by provider. Use limit to set the page size. When more results are available, the response includes page.nextOffset and links.next.href. Pass the nextOffset value as the offset parameter to get the next page.

Partial success

If the Data Provider can only return part of the data, the endpoint responds with HTTP 206 Partial Content and the same response body.

Statement status

Each statement has a status that tells you whether it can be downloaded. The status is set by the Data Provider, so the statements a provider returns, and when they become AVAILABLE, can vary.

STATUS	DESCRIPTION
`AVAILABLE`	The statement is ready to download.
`PROCESSING`	The statement is still being generated. Try again later.
`FAILED`	Generating the statement failed. It can’t be downloaded.

Not all Data Providers support this endpoint

If the Data Provider does not support statements, this endpoint returns error 501 (Subsystem unavailable) with a 405 status code.

How to handle an error response

If you receive an error response, refer to the List of Data Access Errors for more information about the error and how to resolve it.

{
  "page": {
    "nextOffset": "97fcd39f-6e32-470b-a107-d4cb1080abcc",
    "totalElements": 12
  },
  "links": {
    "next": {
      "href": "https://ob-preprod.flinksapp.dev/api/fdx/5/accounts/11/statements?startTime=2025-01-01&endTime=2025-12-31&limit=2&offset=97fcd39f-6e32-470b-a107-d4cb1080abcc"
    }
  },
  "statements": [
    {
      "accountId": "11",
      "statementId": "20001",
      "statementDate": "2025-12-31",
      "description": "December 2025 statement",
      "status": "AVAILABLE"
    },
    {
      "accountId": "11",
      "statementId": "20002",
      "statementDate": "2025-11-30",
      "description": "November 2025 statement",
      "status": "PROCESSING"
    }
  ]
}

{
  "statements": [
    {
      "accountId": "11",
      "statementId": "20012",
      "statementDate": "2025-01-31",
      "description": "January 2025 statement",
      "status": "AVAILABLE"
    }
  ]
}

{
  "code": 702,
  "message": "Invalid start or end date",
  "debugMessage": "Start time is invalid"
}

{
  "code": 500,
  "message": "Internal Server Error",
  "debugMessage": "An unexpected error occured"
}

Authorizations

Authorization

string

header

required

Bearer token obtained from the /Token endpoint.

Path Parameters

account_id

string

required

The ID of the customer account that you want to retrieve statements for.

Query Parameters

startTime

string<date>

The first date in the date range that you want to retrieve statements for, in ISO format (YYYY-MM-DD).

endTime

string<date>

The last date in the date range that you want to retrieve statements for, in ISO format (YYYY-MM-DD).

offset

string

Opaque cursor used by the provider to send the next set of records.

limit

integer

The maximum number of statements that you want to return with this request. Use this field to set a limit on the amount of data you receive.

Response

Returned when the statements are successfully retrieved with pagination.

page

object

Pagination information for the response.

Show child attributes

links

object

Links for pagination.

Show child attributes

statements

object[]

List of statements for the account.

Show child attributes

API Reference

Auth

Connect

Enrich

Outbound

Pay

Upload

Utilities

Filter and paginate results

Partial success

Statement status

How to handle an error response

Authorizations

Path Parameters

Query Parameters

Response

​Filter and paginate results

​Partial success

​Statement status

​How to handle an error response

Authorizations

Path Parameters

Query Parameters

Response

Filter and paginate results

Partial success

Statement status

How to handle an error response