For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get a task

GET /2.0/mass-payout/task?id={uuid}

One payout task of yours, by id.

Permission: can_payout.

Query parameter
Required
Type

id

yes

UUID

Response 200

{
  "id": "{uuid}",
  "type": "multi_tx",
  "status": "success",
  "subStatus": "payout_sent",
  "payoutId": "{payoutId}",
  "amount": "100000000000000000000",
  "amountInUsd": "100.00",
  "assetId": "5c3767ab-220c-4fce-b3af-20ffcf2d2729",
  "crypto": {
    "id": "{cryptoId}",
    "title": "Binance Pegged USDT",
    "symbol": "USDT",
    "contractAddress": "0x0000000000000000000000000000000000000000",
    "decimals": 18,
    "logoURI": "https://raw.githubusercontent.com/0xsquid/assets/main/images/tokens/usdt.svg"
  },
  "network": {
    "id": "{networkId}",
    "title": "BNB Chain",
    "symbol": "BSC",
    "chainId": "56",
    "networkType": "evm"
  },
  "transferTxHash": "{transferTxHash}",
  "payoutTxHash": "{payoutTxHash}",
  "targetsCount": 4,
  "fee": {
    "network": [
      {
        "amount": "2650000000000000",
        "amountFormatted": "0.00265",
        "currency": "BNB",
        "cryptoId": "75608cde-155c-4550-8025-cddf01bf2289",
        "networkId": "e130ce89-1d4d-4951-beaf-465ec43cf399",
        "amountInUsd": null,
        "isChargedToMerchant": false
      }
    ],
    "service": {
      "amount": "1000000000000000000",
      "amountFormatted": "1",
      "currency": "USDT",
      "cryptoId": "1fa107f9-3832-4286-9c72-493eaf675da5",
      "networkId": "e130ce89-1d4d-4951-beaf-465ec43cf399",
      "amountInUsd": "1.00",
      "isChargedToMerchant": true
    },
    "exchange": null,
    "totalInUsd": "1.00"
  },
  "createdAt": "2026-07-28T10:53:41+00:00"
}

type: single_tx | multi_tx. status: pending | failed | success.

The single network leg is the sum of all gas of the task: the transfer transaction, the payout transaction, and the per-target transactions. It carries amountInUsd: null and isChargedToMerchant: false - that gas is spent from your own payment address (which the Gas Manager funds), we never priced it in USD, and it is not part of totalInUsd. To see what the gas supply itself cost you, read gas-manager/list.

Codes

Same as deposit/get, with can_payout instead of can_invoice.

Last updated