v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Transfers

Get a specific transfer

Retrieves detailed information about a specific transfer including status, agents, and policy evaluations. Supports optional PII decryption, timeline, and integration results.

get/entities/{entityDID}/tx/{transferId}

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

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

The DID of the entity

transferIdstring uuid required

Example:01f09c55-9de0-42c5-874f-237dcb51fd9f

The transfer ID

Query parameters

decrypt'true' | 'false'

Whether to decrypt PII data in the response

sanitize'true' | 'false'

Whether to sanitize sensitive data in the response

include_timeline'true' | 'false'

Whether to include the timeline of events for the transfer

include_integration_results'true' | 'false'

Whether to include integration results in the response

include_replacedstring

Whether to include replaced agents in the response

include_removedstring

Example:true

include_commentsstring

Example:true

Response

Transfer details retrieved successfully

Example response

{
  "transfer": {
    "@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": []
  }
}