v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Transfers

Create a new transfer

Creates a new transfer from the specified entity to another entity. This is the entry point for initiating a new transfer in the system.

post/entities/{entityDID}/tx

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

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

The DID of the entity

Request body

assetstring required

amountstring required

refstring required

settlementIdstring

Transaction hash in CAIP-220 format (e.g., eip155:1:tx/0x...). Raw hashes are automatically normalized to CAIP-220 when chain context is available from the asset.

memoTagstring

Example request

{
  "originator": {
    "@id": "did:web:originator.example.com"
  },
  "beneficiary": {
    "@id": "did:web:beneficiary.example.com"
  },
  "asset": "eip155:1/slip44:60",
  "amount": "1.5",
  "agents": [
    {
      "@id": "did:web:vasp-a.example.com",
      "role": "VASP",
      "for": "did:web:originator.example.com"
    },
    {
      "@id": "did:web:vasp-b.example.com",
      "role": "VASP",
      "for": "did:web:beneficiary.example.com"
    }
  ],
  "ref": "tx-ref-12345"
}

Response

Transfer created 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": []
  }
}