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 (if the notification for this is set up). Users who already exist will simply receive the funds sent to them (and a notification, if one is set up).
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 user or debit account are performed and either a specified credit account for each user will be credited, or the primary account of a recipient if only a recipient - but no credit account - is specified.
How do I use the Mass Send Extension?
Dashboard
First, ensure that the debit account - or primary account of the user, if a user is specified rather than a debit account - for the mass send has the correct currency and enough balance to credit all of the recipients. The debit account can be any account in the system.
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 available:
* = required field
** = required field in some circumstances, see Filling out the CSV below.
amount*
user**
recipient*
credit_account
currency*
debit_account**
debit_note
debit_metadata
debit_reference
credit_note
credit_metadata
credit_reference
Most of the fields are optional. Required fields are amount, recipient, currency, and either user or debit_account.
Once an admin has created their mass send CSV, they can upload the CSV and then run the mass send.
Web app
Admins and merchants can also 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. Using Mass send through the web app works differently to using it through the Dashboard: you have to have the debit account on the user you are sending from, i.e. you cannot send from any account in the system. Web app mass send users also have access to an example CSV file. Required fields are amount, recipient, and currency.
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 can include the following data:
* = required field
** = required field in some circumstances
Amount*
The amount you want to send to your users. Required field.
User**
Only applicable when using the Mass Send Extension through the Dashboard.
The email address of the user you want to send funds from. If no debit account is specified, the user field is a required field. The Mass Send Extension will try to send from the user's primary account. If the user has no primary account, the mass send will not work. If user and debit account are both filled in, but the debit account does not belong to the user, the Mass Send Extension will throw an error.
Recipient*
The email address of the user you want to send funds to.
Credit account
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 in.
Currency*
The currency you want to send to your users. Use the currency code e.g. USD
Debit account**
The account reference of the account the funds will be coming from. The specified debit account will need to have the currency you are sending in and enough balance to cover the credits.
When mass sending from the Dashboard
If no user is specified, this is a required field when using mass send through the Dashboard, as the Mass Send extension needs to know which account to draw funds from.
When mass sending from the web app
This field is not required to mass send from the web app - if no debit account is specified, the Mass Send Extension will attempt to send from the logged in user's primary account. This field can be used to send from a non-primary account of the logged in user. If a debit account is specified, it must be an account that exists on the user who is logged in and will be running the mass send.
Debit note
This is an optional field. It adds a note to the debit transactions and can be used to describe the nature of the transaction.
Debit metadata
This is an optional field. It adds metadata to the debit transactions. If included it should be a JSON object.
Debit reference
This is an optional field. It adds a reference to the debit transactions.
Credit note
This is an optional field. It adds a note to the credit transactions and can be used to describe the nature of the transaction.
Credit metadata
This is an optional field. It adds metadata to the credit transactions. If included it should be a JSON object.
Credit reference
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:
