wallet

Get fund transfer status or history. (admin access required)

Query the status of a fund transfer by id, or list all fund transfers for a wallet. Poll this endpoint after posting to /wallet/transfer-funds. Status values: Pending (queued or submitted), Confirmed (on-chain), FailedViaManualReset (submission error), FailedViaTimeout (no confirmation within timeout).

get/wallet/transfer-funds

Request

Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
URL: ./../api/v1/wallet/transfer-funds
Auth: API key in header token

Query parameters

idstring

Query a specific fund transfer by id

hotWalletIdstring

Query all fund transfers for a wallet by internal id

walletAddressstring

Query all fund transfers for a wallet by its Cardano address

cursorIdstring

Cursor for pagination

limitinteger

Number of results to return (1-100, default 20)

Response

Fund transfer list

status'success' required

Example response

{
  "status": "success",
  "data": {
    "transfers": [
      {
        "id": "unique_cuid_v2_of_fund_transfer",
        "status": "Confirmed",
        "txHash": "a3f8c12d9e4b71d2f0e5c8a9b3d6e7f1a2b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8",
        "toAddress": "addr_test1qz8x...purchasing_wallet_address",
        "lovelaceAmount": "100000000",
        "assets": null,
        "createdAt": "1970-01-20T20:00:36.260Z",
        "updatedAt": "1970-01-20T20:00:36.260Z",
        "lastCheckedAt": "1970-01-20T20:00:36.260Z",
        "errorNote": null
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.