Mass Payouts
Last updated
Last updated
The Mass Payouts tab provides an interface for initiating multiple outgoing crypto transactions at a time. This can include transactions of different amounts made in different cryptocurrencies.
Initiating a mass payout involves processing a special CSV file and creating a transaction based on each data row. Each transaction will then be processed in accordance with the general transaction flow, with the mass payout getting its status based on all the transactions' statuses.
Being an alternative interface to withdrawals, this feature works within the same limitations as they do. For example, each individual transaction in a mass payout may be a subject to your merchant's interface withdrawal limits.
To make a mass payout, you need to prepare a CSV file describing all the transactions you want to make. The file must contain no more than 100 data rows, and its size must not exceed 1 MB.
Each data row must contain five values, separated by either commas or semicolons:
Address — the recipient's address.
Tag — the recipient's Tag field. Leave empty for transactions that do not require a Tag field.
Currency — the ISO code of the currency to send.
Amount — the amount of funds to send.
Note — a note to save in the transaction history. Leave empty to skip adding a note for the transaction.
The file must start with a header row that lists these columns in the specified order.
Below is an example of a valid CSV file for a mass payout.
Once you prepared a CSV file for a mass payout, you can upload it and initiate a mass payout.
On the Mass Payouts tab, click Create mass payout.
Enter a name for this payout.
Click Upload file and choose the CSV file from your device.
Check the preview table to make sure that the CSV file was loaded correctly.
If the cryptoprocessing detects a critical error in a specific row, it will show an exclamation mark next to the row. Hover it to see the error message. For your convenience, the first column always indicates the line number at which the invalid data was found in the CSV file.
Fix all the critical errors in your file and click Reupload file to upload and check it again.
Check the total estimation at the bottom of the table. It includes:
the total withdrawal amount in the equivalent currency,
a subtotal withdrawal amount for each cryptocurrency, both in the cryptocurrency itself and in the equivalent currency.
Note that the amounts in the equivalent currency are for information purposes only. The actual costs may change due to both the cryptoprocessing's fees and the network's mining fees. Both of them are applied to each transaction only after the cryptoprocessing considers it confirmed.
Confirm the action by entering the 2FA code and clicking the Send payouts button.
The table on the Mass Payouts tab displays all mass payouts created by the merchant. It contains the following columns:
ID — a unique internal identifier of the mass payout.
Name — the name that was entered when initiating the mass payout.
Date — the date and time when the mass payout was initiated.
Payouts processed — how many rows from the original CSV files have been processed.
For example, “10 out of 20” would indicate that the CSV file contains 20 data rows, but the cryptoprocessing has only attempted to create the transactions for 10 of them so far.
Transactions created — how many transactions were created as part of the mass payout.
Normally, this value increases and eventually becomes the same as the number of Payouts processed. However, the cryptoprocessing may fail to create some transaction due to insufficient funds, an invalid recipient address or other unexpected errors. See Retrying unsuccessful transactions below.
Status of mass payout:
Processing — the cryptoprocessing is still creating the transactions based on the CSV file or waiting for the transactions to be completed.
Transaction on moderation — one or more transactions require another owner's approval, due to the withdrawal limits settings.
Completed with errors — all created transactions are completed, but some transactions either could not be created or failed after creation.
Completed — all transactions were created and completed successfully.
Note that the table shows the Payouts processed and Transactions created values at the moment of the latest page update. The actual values may change rapidly, especially while the CSV file is still being processed. Refresh the page to get the latest information.
Click on a mass payout to open the panel with more details about it. The panel includes all the data from above, as well as the following counters:
Transactions created — the number of successfully created transactions. Click on the number to see this mass payout's transactions on the Transactions tab.
Below the counter, a separate counter will be shown for each status that transactions from this mass payout got. Click on a number to see the mass payout's transactions with the given status on the Transactions tab.
Transactions not created — the number of rows from the original CSV file for which the cryptoprocessing failed to create transactions.
For mass payout with at least one failed item in it (either a failure in creating a transaction or an unsuccessful transaction), the panel contains the Export unsuccessful transactions button. Click the button to download a modified version of the original CSV file, with all successful transactions removed.
The button for downloading the file appears as soon as at least one failure occurs during the mass payout. The file may change after that if more transactions will be unsuccessful.
Besides the original data, the file contains additional columns:
Status — either the status of an unsuccessful transaction (Failed, Declined, Canceled) or Not created if the cryptoprocessing failed to create a transaction based on this data row.
Error — an error message explaining why the transaction was unsuccessful.
If you believe that the cause of the errors is fixed (you added more funds to your balances, you added a missing Tag field, etc.), you can remove the Status and Error columns from the CSV file and use it for initiating a new mass payout.
