Sign in
wallet

Queue a fund transfer from a wallet. (admin access required)

Queues an asynchronous transfer of lovelace (and optional native assets) from a hot wallet to a target Cardano address. The transfer is picked up by the background processor once the wallet is free. Poll GET /wallet/transfer-funds to check status.

post/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

Request body

fromWalletAddressstring required

The Cardano address of the hot wallet to send funds from

toAddressstring required

The Cardano address to send funds to

lovelaceAmountstring required

Amount of lovelace to transfer (minimum 2000000 = 2 ADA)

Example request

{
  "fromWalletAddress": "addr_test1qx9...source_wallet_address",
  "toAddress": "addr_test1qz8x...destination_address",
  "lovelaceAmount": "100000000"
}

Response

Fund transfer queued

status'success' required

Example response

{
  "status": "success",
  "data": {
    "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.