Create a batch payment file

This tutorial describes the steps involved in creating a batch payment file that's required to send batch payments using Ripple Payments Direct.

With batch payments, you can get a quote for multiple payments and process them all at once, instead of requesting a quote for every single payment; hence, batch payments significantly reduce the time and effort required to send large volume payments. Batch payments also provide faster time to value for customers without an API integration.

Follow these steps to create a batch payment file:

1. In Ripple Payments UI select the Payments tab.
2. Select Create Payment > Batch .
3. Follow the instructions in the How it works section.
   1. Download the batch payment template file .
   2. Enter the payment details .
   3. Upload your file.
4. To check your file for data validation errors and (subsequently) send the batch payment , select Get Quote .
5. Only if you see error messages in the Ripple Payments UI:
   1. In your local file copy, correct all errors according to the error message(s) and save the file copy.
      See the image below for example errors.
   2. In the Ripple Payments UI, select the (trash can) icon to delete the erroneous file.
   3. Upload the corrected version of the file.
   4. Once again, select Get Quote to send the batch payment.

   

Template file

The template file for your batch payment is customized using payment details such as use case and currency.

To create your customized batch payment template:

1. Click Download Template , and create the template by selecting from the following fields:

   Field name	Description
   Use case	The use case for the payment transaction.
   Payment country	The country of the payment originator.
   Payment currency	The currency in which the originator will send the payment.
   Payout country	The country of the payment beneficiaries.
   Payout currency	The currency in which the beneficiaries will be paid out.
   Payout category	The payout category. Only Bank account is available.

2. Select Download Template .

Payment details

Edit the template file to add payment details:

1. Rename the downloaded file to a less generic name that helps you remember details of the batch payment.
   For data validation purposes, you must save and upload the file in either xls or xlsx file format.
2. Open the renamed file.
3. Create one entry per row for each beneficiary you want to include in this batch payment (up to 100 per file).
   For details on the fields you must fill out to create a payment beneficiary entry, hover over the field names.

   Tips to populate payment details:

   • Make sure to enter information for all beneficiaries (up to 100 per file) that can be paid out in the currency specific to that template. This way, you can avoid maintaining and storing multiple files for the same payout currency but different beneficiaries.
   • If you use an editing tool other than Microsoft Excel, make sure to remove any trailing blank columns as they may cause a file processing error.
   • When you enter phone numbers with the digits separated by hyphens, you may have to enclose the number in ' characters to prevent your editing tool from formatting the phone number as a formula.

Payment limitations

The payout currencies currently supported by Ripple Payments Direct have the following payment limitations: