Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transfers

Search transfers with filters

get/entities/{entityDID}/tx/search

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

Query parameters

limitinteger

Maximum number of transfers to return

offsetinteger

Number of transfers to skip

agentDID[]

Filter transfers by agent DIDs

[
  "did:web:vasps.id:jxnl0411:at"
]
statusTransferStatus[]

Filter transfers by status

assetAssetIdentifier[]

Filter transfers by asset identifier

[
  "bip122:000000000019d6689c085ae165831e93/slip44:0"
]
partystring[]

Filter transfers by party identifiers

refsstring[]

Filter transfers by reference identifiers

created_beforestring date-time
Example:2024-01-15

Filter transfers created before this date (ISO 8601)

created_afterstring date-time
Example:2024-01-15

Filter transfers created after this date (ISO 8601)

fieldsstring

Comma-separated list of fields to include in the response.

direction'INCOMING' | 'OUTGOING'

The direction of a transfer relative to the entity

Filter transfers by direction

search_termstring

Search term for full-text search

sort_bystring

Field to sort by

sort_order'asc' | 'desc'

Sort order (asc or desc)

action_requiredboolean

Filter to transfers requiring action

request_for_informationboolean

Filter to transfers with pending information requests

view'list'

Response

Search results retrieved successfully

Example response

{
  "data": [
    {
      "originator": {
        "@id": "did:web:originator.example.com"
      },
      "beneficiary": {
        "@id": "did:web:beneficiary.example.com"
      },
      "agents": [
        {
          "@id": "e6630d6a-5e3d-4a23-a638-94a1f4c2893b",
          "@type": "TransferAgent",
          "agent": {
            "@id": "did:web:vasp.example.com"
          },
          "name": "Example VASP",
          "for": "did:web:customer.example.com",
          "role": "VASP",
          "status": "PROCESSING",
          "relationship": {}
        }
      ]
    }
  ]
}