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 in 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?
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.)
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).
Filling out the CSV
To create your CSV you need to include the following data:
Amount: This is the amount you want to send to your users.
Recipient: The email address of the user you want to send funds to.
Credit account: 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.
Currency: The currency you want to send to your users.
Debit account: Fill this out with the account reference of the account the funds will be coming from. This is a required field as the Mass Send extension performs a transfer from the debit account to the users’ accounts.
Debit note: This is an optional field. It adds a note to the debit translations 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 translations.
Credit note: This is an optional field. It adds a note to the credit translations 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 translations.
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: