Beneficiary Registration

i-payout's batch processing feature enables efficient bulk beneficiary registration. Merchants can compile a batch file with records for each beneficiary they wish to register, facilitating mass operations.

Step 1: Download Example File

From i-payout's main page, hover over the End Users menu and click Import Users.

In the Import Users screen, you can find example files in CSV and Excel format. To download the file in your preferred format, click the links on the admin portal or click the links here for CSV or Excel.

The supported file formats are:

  • CSV (Comma-Separated Values)
  • XLSX (Microsoft Excel Open XML Spreadsheet)

Step 2: Fill in the Information

Batch File Structure

The files submitted must adhere to a specific structure to ensure proper processing:

  • Header Row: The first row must contain field names as specified in the documentation.
  • Data Rows: Following the header, each row represents a customer record to be registered.

Record Format

The format for customer registration records is detailed below.

Field NameDescriptionData TypeRequired
UserNameUnique username for the customerStringYes
FirstNameCustomer's first nameStringYes
LastNameCustomer's last nameStringYes
CompanyNameName of the customer's company (if applicable)StringNo
Address1Primary street addressStringNo
Address2Secondary street address (if any)StringNo
CityCity of residenceStringNo
StateState of residenceStringNo
ZipCodePostal codeStringNo
Country2xFormatTwo-letter country codeStringNo
PhoneNumberPrimary phone numberStringNo
CellPhoneNumberMobile phone numberStringNo
EmailAddressPrimary email addressStringNo
SSNSocial Security Number (if applicable)StringNo
CompanyTaxIDTax identification number for the companyStringNo
GovernmentIDGovernment-issued identification numberStringNo
MilitaryIDMilitary identification number (if applicable)StringNo
PassportNumberPassport numberStringNo
DriversLicenseDriver's license numberStringNo
DateOfBirthCustomer's date of birthDateNo
WebsitePasswordPassword for website accessStringNo
DefaultCurrencyPreferred currency for transactionsStringNo
PreferredLanguagePreferred language for communicationsStringNo
SecondaryEmailAddressSecondary email address (if any)StringNo
skipAutoSvcOrderIndicates if automatic service orders should be skippedBooleanNo
isBusinessUserIndicates if the user is a business userBooleanNo
businessUsernameUsername for business users (if applicable)StringNo
secondaryEmailAn additional email addressStringNo

Step 3: Submit File

To create beneficiaries, you must submit the file with the beneficiaries' information.

  1. Hover the mouse over the End Users menu and click Import Users. Click Choose File, select the file with the information of the beneficiaries you want to register and click Upload.
  1. Check that all beneficiaries appear in the Users to Import table. Beneficiaries who appear in the Invalid users NOT to import table will not be imported, and their information should be corrected. Once all beneficiaries appear in the correct table, click Submit Import.