API Reference

Retrieve a list of paginated card transactions

get
https://api.floatfinancial.com/v1/card-transactions

Lists card transactions for the business.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

The accounting stage of the card transactions to filter by.

  • IN_REVIEW - IN_REVIEW
  • READY_TO_EXPORT - READY_TO_EXPORT
  • EXPORTED - EXPORTED
Allowed:
date-time
Defaults to 1970-01-01T00:00:00Z

Filter for records created at or after this timestamp. Default is the epoch start time in UTC.

date-time | null

Filter for records created at or before this timestamp. Default is the current UTC time.

gl_code
array of uuids
Defaults to []

The IDs of the GL codes to filter the card transactions by. Matches the GL code at the transaction level or on any line. Accepts a comma-separated list.

gl_code
string | null

The merchant name to filter the card transactions by. An exact, case-sensitive match on the normalized merchant name, or on the raw name when the merchant is not normalized. One name per request.

boolean | null

When true, only return card transactions that have no usable GL code. A GL code is considered missing when it is absent, hidden, or inactive at both the transaction and line level.

string
enum
length ≥ 1
Defaults to -created_at

The ordering of the results. Use 'created_at' for ascending order or '-created_at' for descending order.

  • created_at - created_at
  • -created_at - -created_at
Allowed:
integer
≥ 1
Defaults to 1

The page number to retrieve, starting from 1.

integer
1 to 1000
Defaults to 1000

The number of items per page, maximum is 1000.

receipt_status
array of strings
Defaults to []

The receipt statuses of the card transactions to filter by. Accepts a comma-separated list.

receipt_status
Allowed:
string
enum

The spend compliance status of the card transactions to filter by.

  • COMPLIANT - COMPLIANT
  • NOT_COMPLIANT - NOT_COMPLIANT
Allowed:
date | null

Only return card transactions transacted on or after this date (inclusive). Day boundaries use the America/Toronto timezone.

date | null

Only return card transactions transacted on or before this date (inclusive). Day boundaries use the America/Toronto timezone.

user
array of uuids
Defaults to []

The IDs of the users (cardholders) who made the card transactions to filter by. Accepts a comma-separated list.

user
Response

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?