Mass Payouts

Mass payouts are a method that allows making payments to multiple recipients simultaneously.

One of the main advantages of mass payouts is their speed and efficiency. Unlike traditional payment methods, which can take several days, sending cryptocurrency payments takes just a few minutes.

Creating a Mass Payout

POST /v2.0/mass-payouts

Description of Input Parameters

A request to create a mass payout can be made in two ways:

In JSON format

id required	string <uuid> Unique ID of mass payout (UUID format)
external_id	string^[0-9a-zA-Z:._-]{1,255}$ Merchant's external ID for mass payout.
callback_url	string <url> Merchant's callback URL.
fee_payer	string Enum: "merchant" "customer" Fee payer.
required	Array of objects List of payout objects.
otp	string OTP code (if enabled)
with_confirmation	boolean Default: false whether mass payout sending should be confirmed with /send call.

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "external_id": "string",
• "callback_url": "https://example.com/callback",
• "fee_payer": "customer",
• "payouts": [

  • {

    • "network": "tron",
    • "symbol": "TRX",
    • "address": "0x6EC1868a71F73784c35AD177c6DBA70D22908164",
    • "amount": "3.12",
    • "external_id": "ABC-DEF-001"

    }

  ],
• "otp": "123456",
• "with_confirmation": true

}

Example request:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_id": "EXT-0AAD04FF",
  "callback_url": "https://example.com/callback",
  "payouts": [
    {
      "network": "ethereum",
      "symbol": "ETH",
      "address": "0x6EC1868a71F73784c35AD177c6DBA70D22908164",
      "amount": "3.12",
      "external_id": "ABC-DEF-001"
    }
  ],
  "otp": "123456"
}

Through uploading a .CSV file

You need to prepare a .csv file in the following format:

It is permissible to describe payouts in different currencies and networks in one .csv file.

Example request for file upload:

curl --request POST
  --url https://api.cryptix.io/v2.0/mass-payouts
  --header 'Content-Type: multipart/form-data'
  --cookie session=<session_id>
  --form "payouts=@/data/example.csv;type=text/csv"
  --form id=93fe3749-271d-4d04-9396-d3e89a8a5966
  --form otp=749302
  --form external_id=abc-def
  --form callback_url=http://example.com/callback

Description of Response

id required	string <uuid> ID of mass payout.
status required	string Enum: "new" "pending" "processed" Status of mass payout.
fee_payer required	string Enum: "merchant" "customer"
external_id	string^[0-9a-zA-Z:._-]{1,255}$
required	Array of objects List of payouts related to this mass payout.
created_at	string <date-time> Mass payout creation date.
expires_at	string <date-time> Mass payout expiration date (if present).
	Array of objects (SummaryItem)

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "status": "new",
• "fee_payer": "merchant",
• "external_id": "string",
• "payouts": [

  • {

    • "id": "145DF542-0399-45B1-83E4-55EBAB26725A",
    • "status": "completed",
    • "ext_tx_id": "0xbf371d90a538cc9fdc1b64f29d15f19a0d238c8f33617468a29c4bfafa405a12",
    • "network": "tron",
    • "symbol": "TRX",
    • "address": "0x6EC1868a71F73784c35AD177c6DBA70D22908164",
    • "amount": "3.12",
    • "callback_url": "https://example.com/callback",
    • "external_id": "582F6CFE-32ED-47E2-B1A5-8AD0AE6CD508",
    • "fees": {

      • "total_fee": "0.001",
      • "percent": {

        • "value": "0.5",
        • "amount": "0.0005"

        },
      • "fix": {

        • "value": "0.0005",
        • "amount": "0.0005"

        }

      }

    }

  ],
• "created_at": "2023-07-12T14:10:47Z",
• "expires_at": "2023-07-12T14:20:47Z",
• "summary": [

  • {

    • "network": "tron",
    • "symbol": "TRX",
    • "totals": {

      • "amount": "0.1",
      • "fees": {

        • "merchant": "0.1",
        • "customer": "0.1"

        }

      }

    }

  ]

}

Possible statuses of the Mass Payout object:

• pending — payouts in progress;
• processed — this status indicates that the processing of payouts is complete but does not guarantee the successful sending of all payments.

Getting a List of All Mass Payouts

GET /v2.0/mass-payouts

This method allows obtaining a list of mass payouts.