Get current transfer clearance and history

GET

/transactions/:id/travel-rule/transfer

GET

/api/v1/transactions/:id/travel-rule/transfer

curl https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule/transfer \
     -H "Authorization: Bearer <apiKey>"

{
  "transfer": {
    "id": "string",
    "transactionId": "string",
    "assessmentId": "string",
    "externalTransactionId": "string",
    "revision": 1,
    "assessmentGeneration": 1,
    "state": "AWAITING_INFORMATION",
    "decision": "ALLOW",
    "exchangeStatus": "NOT_REQUIRED",
    "settlementStatus": "UNKNOWN",
    "canRelease": true,
    "evidenceCurrent": true,
    "reasons": [
      "string"
    ],
    "recommendedAction": "PROCEED",
    "expiresAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "history": [
      {
        "revision": 1,
        "state": "AWAITING_INFORMATION",
        "decision": "ALLOW",
        "exchangeStatus": "NOT_REQUIRED",
        "settlementStatus": "UNKNOWN",
        "reasons": [
          "string"
        ],
        "assessmentGeneration": 1,
        "createdAt": "2024-01-15T09:30:00Z"
      }
    ],
    "direction": "INBOUND",
    "exchangeProtocol": "TRP",
    "countryReview": {
      "reviewed": true,
      "jurisdictionsIncomplete": true,
      "countries": [
        {
          "country": "string",
          "status": "MISSING"
        }
      ]
    },
    "exchangeProgress": {
      "status": "NOT_PREPARED",
      "messageId": "string",
      "confirmation": {
        "messageId": "string",
        "status": "CONFIRMED",
        "settlementStatus": "UNKNOWN"
      },
      "response": {
        "messageId": "string",
        "status": "QUEUED"
      }
    },
    "execution": {
      "id": "string",
      "authorisationId": "string",
      "externalExecutionId": "string",
      "consumedAt": "2024-01-15T09:30:00Z",
      "settlementStatus": "UNKNOWN",
      "purpose": "OUTBOUND_TRANSFER",
      "confirmation": {
        "messageId": "string",
        "confirmedAt": "2024-01-15T09:30:00Z",
        "source": "CUSTOMER",
        "status": "QUEUED"
      }
    },
    "exchangeMessages": [
      {
        "id": "string",
        "direction": "INBOUND",
        "operation": "inquiry",
        "status": "RECEIVED",
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "evidencePurged": true
      }
    ]
  },
  "replayed": true,
  "commandRevision": 1
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired1-200 characters

Response

Success

transferobject or null

Revision-bound compliance clearance. Completion never implies blockchain settlement. Unqualified policies and unavailable exchange remain held. Read again immediately before acting; this is not a signed execution token.

replayedbooleanOptional

commandRevisionintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error

503

Service Unavailable Error

Authentication

Path parameters

Headers

Response

Errors