Skip to main content
GET
curl

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Query Parameters

direction
string

INBOUND, OUTBOUND, or both comma-separated. Case-sensitive.

status
string

One or more transfer statuses, comma-separated.

rail
string

One or more of INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP, comma-separated.

kind
string

withdrawal, deposit or message, comma-separated.

currency
string

The transaction's currency, case-insensitive.

start_date
string<date>

Transfers created on or after this day (UTC), YYYY-MM-DD.

end_date
string<date>

Transfers created on or before this day (UTC), YYYY-MM-DD.

counterparty
string<uuid>

The id of a directory entry or Didit network member from GET /v3/travel-rule/vasps/: your transfers with that counterparty. A value that is not a valid id answers 400.

limit
integer

Page size, default 50.

Required range: x >= 1
offset
integer

Rows to skip.

Required range: x >= 0

Response

A page of transfers.

count
integer
next
string | null
previous
string | null
results
object[]