Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transactions

List transactions

Fetches a list of transactions belonging to a VASP. Transactions can be sorted, filtered, and searched and results are paginated.

get/tx/list

Query parameters

vaspDIDstring required

Decentralized Identifier

Example:did:methd:identifier

vaspDID to get list for

sort'transactionAmount:ASC' | 'transactionAmount:DESC' | 'updatedAt:ASC' | 'updatedAt:DESC' | 'createdAt:ASC' | 'createdAt:DESC'

Pass one of the supported fields you want to sort and after the colon (:), the direction, ASC or DESC.

pageinteger

Page number the user wants to retrieve, default value is 0

resultsPerPageinteger

Number of records to show per page, default value is 100

txGroupstring

Pass INBOX here to return only the transfers available on your inbox, or remove the param to return all transfers

Example:INBOX
transactionAssetstring

Filter your transfers by crypto currencies

Example:ETH
transactionType'TRAVELRULE' | 'BELOW_THRESHOLD' | 'NON_CUSTODIAL' | 'UNKNOWN'

Filter your transfers by type

transactionRefstring
statusstring[]

Filter your transactions by status

qstring

Search term for transactions

txDirection'incoming' | 'outgoing' | 'internal'

Filter your transfers by direction, incoming, outgoing or internal transfers

decryptboolean

Decrypt PII data

csvboolean

Get data in CSV format

includeActionsboolean

Include action data with the transactions

jurisdictionsstring[]

Filter your transactions by jurisdictions

vaspsstring[]

Filter your transactions by vasps

startstring date
Example:2023-07-20

Filter your transactions created after the specified date (included)

endstring date
Example:2023-07-20

Filter your transactions created before the specified date (included)

walletstring

Filter your transactions by wallet address

Response

List of TransferInformation