v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Transfers

List transfers for an entity

Retrieves a paginated list of transfers for the specified entity. Supports filtering by status, asset, direction, date range, and more.

get/entities/{entityDID}/tx

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

List of transfers retrieved successfully

Example response

{
  "data": [
    {
      "@id": "0dd6c308-4d79-49d0-ab4f-c1536bbda182",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z",
      "asset": "eip155:1/slip44:60",
      "amount": "1.5",
      "ref": "tx-ref-12345",
      "initiator": "did:web:vasp-a.example.com",
      "status": "OUTGOING",
      "direction": "OUTGOING",
      "authorizationRequested": false,
      "transactionType": "TRANSFER",
      "log": [],
      "flags": [],
      "amounts": [],
      "agents": [
        {
          "agent": {
            "@id": "did:pkh:eip155:1:0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"
          },
          "@id": "e6630d6a-5e3d-4a23-a638-94a1f4c2893b",
          "@type": "TransferAgent",
          "for": "did:web:vasp-a.example.com",
          "relationship": {},
          "status": "PROCESSING",
          "role": "SourceAddress"
        },
        {
          "agent": {
            "@id": "did:web:vasp-a.example.com"
          },
          "@id": "4e482170-ae75-4069-85fd-7f5d44a913b8",
          "@type": "TransferAgent",
          "name": "VASP A",
          "for": "did:web:originator.example.com",
          "relationship": {},
          "status": "PROCESSING",
          "role": "VASP"
        },
        {
          "agent": {
            "@id": "did:web:vasp-b.example.com"
          },
          "@id": "c563c086-253f-4f12-bec0-2b5294fc6826",
          "@type": "TransferAgent",
          "name": "VASP B",
          "for": "did:web:beneficiary.example.com",
          "relationship": {},
          "status": "PROCESSING",
          "role": "VASP"
        }
      ],
      "originator": {
        "@id": "did:web:originator.example.com"
      },
      "beneficiary": {
        "@id": "did:web:beneficiary.example.com"
      },
      "policyEvaluations": []
    }
  ]
}