What is the Mass Send Extension?
The Mass Send Extension is a convenient way to invite and send funds to many users at once. If you send to a user who doesn’t exist in the system yet they will be sent an email inviting them to join and claim their funds. Users who already exist will simply receive the funds sent to them.
The extension works by processing a CSV file which has a list of transactions to be performed. Admins create this CSV file and upload it to the Mass Send Extension via either the Dashboard or the web App. Transfer transactions from a specified debit account are performed and either a specified credit account for each user will be credited, or their primary account if no credit account is specified.
How do I use the Mass Send Extension?
Ensure that the user who will be executing the mass send has an account with the correct currency and enough balance to credit all of the recipients. The debit account will have to exist on the user executing the mass send - at the moment you cannot debit a standalone account or the account of another user.
Admins can access the Mass Send Extension through the Rehive Dashboard by going to Extensions -> Mass Send Extension. From here, admins can download an example CSV file. This example file shows which transaction data columns are required. Some of the fields are optional (such as credit_account, debit_note, debit_metadata, debit_reference and credit_note, credit_metadata and credit_reference).
Admins and merchants can access the Mass Send Extension through the Rehive Web App by going to any of their account currencies and clicking on the “Mass send” button in the action list. (You don’t have to match the account currency with the account you’re sending from or the currency you are sending transitions in via Mass Send.)
Ensure that the user you send from has a properly formatted first name and an appropriate email address, as this information will appear as the "from" parameters in the recipient's transaction history. The transaction will appear to the user as "Received from <first name> <last name>" in their transaction history.
Filling out the CSV
To create your CSV you need to include the following data:
The amount you want to send to your users.
The email address of the user you want to send funds to.
Fill this out with the account reference if you want the funds to go to a specific account of the user’s. This is an optional field. If you leave it blank the funds will go to a user’s primary account, as long as the primary account has the currency you are sending.
The currency you want to send to your users. Use the currency code e.g. USD
Fill this out with the account reference of the account the funds will be coming from. It should be an account that exists on the user who will be running the mass send. Mass send can only debit accounts of the user running it. The account will also need to have the currency you are sending in and enough balance to cover the credits. This is a required field as the Mass Send extension performs a transfer from the debit account to the users’ accounts.
This is an optional field. It adds a note to the debit transactions and can be used to describe the nature of the transaction.
This is an optional field. It adds metadata to the debit transactions. If included it should be a JSON object.
This is an optional field. It adds a reference to the debit transactions.
This is an optional field. It adds a note to the credit transactions and can be used to describe the nature of the transaction.
This is an optional field. It adds metadata to the credit transactions. If included it should be a JSON object.
This is an optional field. It adds a reference to the credit transactions.
You can use software like Microsoft Excel or Google Sheets to create your CSV, just ensure that you export it or save as a CSV format file.
Below is an example of how you might fill out the CSV file: