Skip to main content
GET
/
fdx
/
v6
/
customer
/
{customerId}
/
accounts
/
{accountId}
/
statements
Search for statements
curl --request GET \
  --url https://your-company.com/fdx/v6/customer/{customerId}/accounts/{accountId}/statements \
  --header 'Authorization: Bearer <token>'
{
  "page": {
    "nextOffset": "B47D80MVP23T",
    "totalElements": 3
  },
  "statements": [
    {
      "accountId": "10001",
      "statementId": "20001",
      "statementDate": "2024-01-15",
      "description": "January 2024 Monthly Statement",
      "links": [
        {
          "href": "/accounts/10001/statements/20001",
          "rel": "self",
          "action": "GET",
          "types": [
            "application/pdf"
          ]
        },
        {
          "href": "/accounts/10001/statements/20001/download",
          "rel": "download",
          "action": "GET",
          "types": [
            "application/pdf"
          ]
        }
      ],
      "status": "AVAILABLE"
    },
    {
      "accountId": "10001",
      "statementId": "20002",
      "statementDate": "2024-02-15",
      "description": "February 2024 Monthly Statement",
      "links": [
        {
          "href": "/accounts/10001/statements/20002",
          "rel": "self",
          "action": "GET",
          "types": [
            "application/pdf"
          ]
        }
      ],
      "status": "PROCESSING"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the Authorization header. You should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you must:

  • Verify the signature
  • Ensure the token has not expired by checking the exp claim
  • The sub and iss claims are your data provider subdomain
  • The aud claim is the URI of the resource being requested (excluding any query parameters)
  • The jti value is unique For further detail on security and authentication refer to our Authentication documentation

Path Parameters

​
customerId
string
required

Unique identifier for the user the account belongs to. This will be the user that authorized the data sharing.

Value for a unique identifier

Maximum string length: 256
Example:

"someLongTermUniqueIDString"

​
accountId
string
required

Account identifier, found in the GET /accounts endpoint response.

Note: If the status of the accountId provided is RESTRICTED, you can send a 200 response with an empty body to indicate that no payment networks are available at this time.

Value for a unique identifier

Maximum string length: 256
Example:

"someLongTermUniqueIDString"

Query Parameters

​
offset
string

An opaque ID that indicates there is at least one more page of data available. This value does not need to be numeric or have any specific pattern. If provided, the Data Provider will use this value to send a new request and retrieve the next page. Omitting this value indicates that there is no more data to retrieve.

Example:

"qwer123454q2f"

​
limit
integer

The number of elements that the API consumer wishes to receive. To retrieve multiple pages, the Data Provider will use the opaque nextOffset field to send a subsequent request until the nextOffset is no longer included.

​
startTime
string<date>

Start time for use in retrieval of elements (ISO 8601). For transactions, this should filter by the postedTimestamp of the transaction

ISO 8601 full-date in format 'YYYY-MM-DD' according to IETF RFC3339

Maximum string length: 10
Example:

"2021-07-15"

​
endTime
string<date>

End time for use in retrieval of elements (ISO 8601). For transactions, this should to filter by the postedTimestamp of the transaction

ISO 8601 full-date in format 'YYYY-MM-DD' according to IETF RFC3339

Maximum string length: 10
Example:

"2021-07-15"

Response

Paginated list of available statements

A paginated array of account statements

​
statements
Statement entity · object[]
required

An array of statements, each with its own HATEOAS link to retrieve the account statement

​
page
Page Metadata · object

Contains the opaque identifier, nextOffset, to indicate a paginated result set.