Create a batch payment file
This section 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 different payout currencies) 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.
- In Ripple Payments UI click the Payments tab.
- Click Create Payment > Batch .
-
Follow the instructions in the
How it works
section.
- Download the batch payment template file .
- Enter the payment details .
- Upload your file.
- To check your file for data validation errors and (subsequently) send the batch payment , click Get Quote .
-
Only if you see error messages in the Ripple Payments UI:
-
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. - In the Ripple Payments UI, click the (trash can) icon to delete the erroneous file.
- Upload the corrected version of the file.
- Once again, click Get Quote to send the batch payment.
-
In your local file copy, correct all errors according to the error message(s) and save the file copy.
Template file
-
After you click
Download Template
, create the template by selecting from the following fields:
Field name Description Use case The use case for the payment transaction. Receiver country The country of the payment receiver. Payout currency The currency in which the beneficiary will be paid out. Payout category The payout category. Only Bank
is available. - Click Download Template .
Payment details
-
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 eitherxls
orxlsx
file format. - Open the renamed file.
-
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. For payments to China (USD
), Hong Kong (HKD
), and the Philippines (PHP
), also refer to Bank IDs .Tips:
- Make sure to enter information for all beneficiaries (up to 100 per file) that can be paid out in the currencies 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 Excel, make sure to remove any trailing blank columns as such may cause a file processing error.
-
When you enter phone numbers, you may have to use
'
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:
Currency | Limitation |
---|---|
COP -- Colombian Peso |
Up to 10,000 USD (≈ 40,100,000 COP) per payment to an individual |
EUR -- Euro |
Up to 45,000 EUR per day and beneficiary |
GBP -- British Pound |
Up to 45,000 GBP per day and beneficiary |
HKD -- Hong Kong Dollar |
Up to 400,000 HKD per day and beneficiary |
INR -- Indian Rupee |
Up to 4,000,000 INR per day and beneficiary |
MXN -- Mexican Peso |
Up to 10,000 USD (≈ 175,000 MXN) per payment to an individual |
PHP -- Philippine Peso |
Up to 2,650,000 PHP per day and beneficiary |
USD -- United States Dollar |
Up to 50,000 USD per day and beneficiary |