Bulk-Upload Sandbox Accounts
APICurrentLast updated: January 10th 2022, @ 10:36:49 am
Use Bulk Account Upload to upload up to 40 sandbox accounts at a time by configuring and uploading a file with your sandbox account information.
By configuring multiple sandbox accounts, you can simulate all possible payment scenarios as you test your application.
Configure different Personal sandbox accounts to simulate mock customers as verified, non-verified, credit-card users, PayPal users, payment card users, and so on.
Configure sandbox business accounts to represent merchants, third-party merchants, and "API Caller" accounts.
Create sandbox business accounts to cover the various payment methods that your merchants accept. By configuring a mix of sandbox accounts, you can cover the full range of payment scenarios with your test suites.
Bulk sandbox account file
The bulk sandbox account file consists of a header row followed by rows of sandbox accounts. The following example bulk sandbox account file contains two sandbox accounts—a
US account and a
GB account. The attributes for each account are comma-separated.
Important: In the file you upload to PayPal, place the comma-separated titles of your header rows as they appear in this example. If you use commas in individual fields it is necessary to enclose the field in double quotes so as not to cause an error when loading the file.
To create a bulk sandbox account file, you can either:
- Create your own bulk sandbox account file that contains details for all your sandbox accounts.
- Download the sample bulk sandbox account file and modify it.
Create your own bulk sandbox account file
You can create your own bulk sandbox account file. It must be a UTF-16LE text file that contains the following required fields in the order shown:
|The two-letter country code.
|The account type (
|A unique email address for the sandbox account.
Note: The sandbox never sends email to addresses outside of the sandbox environment.
|A password. A password.
Note: Passwords should be 8-10 character; contain both upper and lowercase letters; and at least one number or symbol, for example,
|A first name for the fictitious account.
|A last name of the account holder.
|A PayPal balance in the range of 0-100000.
|Verified bank status (
|Credit card type (if appropriate) (
|Payment card type (
In addition to providing all required fields for each sandbox account, configure the file as follows:
- Encode the file in UTF-16 Little Endian.
Note: Microsoft Excel uses UTF-16LE encoding when saving files as "unicode text".
- The file must have a
- Separate each attribute in the file with commas.
- The first row of the file must include the header for each sandbox account attribute provided in the file so that the interpreter recognizes the fields the file contains and an error doesn't occur.
- The file must have at least one row of sandbox account data and at most 40 rows of account data.
- The file must not be more than 1 Mb in size.
Download the sample bulk sandbox account file
- You can download the sandbox-bulk-headers.csv sample file.
- Replace the sample rows in the file with the details of all your sandbox accounts.
- Upload the file to the PayPal developer site.
Important: Do not copy and paste the contents of the sample file into a new file, as this may corrupt the formatting of the copied content.
PayPal uses these rules to validate your bulk account file:
- Each sandbox account (row) must contain all required attributes.
- Each field in each row must be of the correct type for the associated attribute and each field must contain a valid value for the associated attribute. For example, all countries, card types, amounts, and so on, must be valid for the column in which they are presented.
- All dependent input fields must be correct for the context in which they are used (for example, only certain card types are valid for each country, and each country-specific validation is honored).
- Values supplied for enums are case-insensitive.
- Each sandbox account email ID must be unique across the file, and it must be an available email address within the sandbox environment.