v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Tokens

Get tokens

The GET /tokens endpoint retrieves a list of all tokens for the authenticated member.

get/tokens

Query parameters

type'INVALID' | 'ACCESS' | 'TRANSFER'

Example:ACCESS

Specifies the type of token returned.

page.offsetstring

The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (<i>i.e.</i> this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data. <br/>The offset is not visible to a user and should not be parsed and/or understood in any way.

page.limitinteger required

Example:175

The maximum number of records to return. This must be less than 200.

filter.sourceAccountIdstring

Example:a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC

Identifies the payer's account.

filter.destinationAccountIdstring

Example:a:f34VSeqwfWGTGH23vsa2cDgecew209jdvcd5vdfv4vds:5VSWVRqicm4Csa2

Identifies the payee/beneficiary's account.

filter.startTimeMsstring string

The filtered list start timestamp in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.

filter.endTimeMsstring string

The filtered list end timestamp in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.

filter.role'ANY' | 'FROM' | 'TO' | 'ISSUER'

Example:ISSUER

Filters by accountHolder role.

filter.actingAsRefIdstring

Filters the list by the sub-TPP identifier generated by Token.io once a TPP has been onboarded.

Response

Successful response

offsetstring

The offset of the first item returned in the collection.