Get a list of transactions

get

https://example.com/v1/transactions

Used to search for transactions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

backfill

boolean

Search by whether the transaction is a backfill

country_code

string

Search by transaction country code.

data_source

string

Search by the input source of the transaction, e.g. API, CSV

decimal_amounts

boolean

A flag to be used in a migration phase. It signals in which format amounts should be parsed. If true amounts are parsed as decimals, if false amounts are parsed as an integer representing the minor currency unit.

direction

string

Search by the Transaction direction, can either be inbound (RECEIVED) or outbound (SENT)

error_types

array of strings

Search by specific error types

error_types

limit

integer

Define page size - default 25

next_cursor

string

Define the next cursor to be fetched

operation_id

string

Search by internal operation unique identifier.

reporting_date_from

string

Search for records where the transaction was reported after a given RFC3339 date

reporting_date_to

string

Search for records where the transaction was reported before a given RFC3339 date

sort_by

string

Order search results by a given field

sort_order

string

Define sort order - default ascending

supplier_company_id

string

Search by company using Fonoa unique identifier.

supplier_company_name

string

Search by company name.

transaction_date_from

string

Search for records where the transaction was executed after a given RFC3339 date

transaction_date_to

string

Search for records where the transaction was executed before a given RFC3339 date

transaction_id

array of strings

Search by external transaction unique identifier(s).

transaction_id

transaction_number

array of strings

Search by transaction number(s).

transaction_number

transaction_reference_id

string

Search by transactions that references the given fonoa id.

transaction_scenario

string

Search by the effect the document has, either debiting or crediting

transaction_status

string

Search by Transaction status.

updated_at_from

string

Search for records updated at or after a given RFC3339 date

updated_at_to

string

Search for records updated at or before a given RFC3339 date

workflow_operations

string

Search by workflow operations as a comma-separated string, e.g. DOCUMENT_GENERATION,TA_NOTIFICATION.

workflow_status

string

Search by Transaction workflow status.

Responses

401

Authentication failed - missing or incorrect subscription key

429

Too many requests were sent for a short period of time. Try again a bit later.

200Ok - transactions for the provided search criteria were returned.

400Bad customer request - invalid search parameters.

5XXInternal server error. Its not you, its us! We are experiencing a rare and unexpected system disruption. Retry again later. The message field of the response will contain more information for the cause. Feel free to contact us.