Test in sandbox

DocsCurrent

Last updated: Mar 25th, 6:05am

You can test most merchant account creation errors and process view responses in the sandbox. To observe the response in the case of a misformatted data point, you can intentionally enter incorrect data when you create an account.

To impose limitations for testing negative scenarios while creating merchant accounts:

Add LMTN as a prefix to the individual_owners.names.given_name attribute in the POST /v3/customer/managed-accounts request.

Trigger onboarding or compliance failures. To simulate these failures, exclude data points or include the keyword DECLINED.

Important:

From now on, you do not have to specify the LMTN keyword. PayPal has introduced a limitation flag for imposing limitations, removing the necessity for the LMTN keyword.

The merchant account has the limitation flag enabled by default. To disable the flag, work with your PayPal integration engineer or contact us.

You can impose limitations by adopting use-case specific simulation keywords, as shown in the following examples:

Use case scenarios and simulation codes

Account with missing business information

Account with incorrect primary authorized user information

Account declined by PayPal Risk rules

Account with an incorrect IBAN code

Account with a blocked routing number

Account with missing credit capability

Account with incorrect bank account number

Account that failed bank confirmation many times

Account with a fraudulent bank account number

Account with a blocked routing number and branch code

Note: All the use-case scenarios discussed here include merchant accounts with the limitations flag enabled by default.

Account with missing business information

Use case: Create a merchant account with an incorrect merchant name (primary authorized user) or business information that fails the electronic verification.

Simulation code: The business_entity.names.business_name must be DECLINED.

Sample request
Sample response

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "Mary",
13                    "surname": "Collins"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "Campus 611 - 1876",
18                "address_line_2": "West Seattle",
19                "admin_area_2": "Seattle",
20                "admin_area_1": "WA",
21                "postal_code": "98109",
22                "country_code": "US"
23            },
24            "birth_details": {
25                "date_of_birth": "1995-05-30"
26            },
27            "phone_numbers": [
28                {
29                    "country_code": "030",
30                    "national_number": "6151175",
31                    "extension_number": "1",
32                    "type": "MOBILE"
33                }
34            ],
35            "identification_documents": [
36                {
37                    "type": "SOCIAL_SECURITY_NUMBER",
38                    "identification_number": "050-64-9837",
39                    "issuing_country_code": "US"
40                }
41            ],
42            "emails": [
43                {
44                    "email": "add_email2@provider.com"
45                }
46            ],
47               "citizenship": "US"
48        
49        }
50    ],
51    "business_entity": {
52        "merchant_category_code": 5933,
53        "type": "CORPORATION",
54        "names": [
55            {
56                "type": "LEGAL",
57                "business_name": "DECLINED"
58            }
59        ],
60        "emails": [
61            {
62                "email": "email5@provider.com"
63            }
64        ],
65        "phone_numbers": [
66            {
67                "type": "BUSINESS",
68                "country_code": "1",
69                "national_number": "06151188"
70            }
71        ],
72        "website_info": {
73            "website_exists": true,
74            "website_url": "www.test.com"
75        },
76        "addresses": [
77            {
78                "address_line_1": "Campus 611 - 1876",
79                "address_line_2": "West Seattle",
80                "admin_area_2": "Seattle",
81                "admin_area_1": "WA",
82                "postal_code": "98109",
83                "country_code": "US",
84                "type": "BUSINESS"
85            }
86        ],
87        "identification_documents": [
88            {
89                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
90                "identification_number": "111222333",
91                "issuing_country_code": "US"
92            }
93        ],
94        "beneficial_owners": {
95            "individuals": [
96                {
97                    "percentage_of_ownership": "35",
98                    "names": [
99                        {
100                            "type": "LEGAL",
101                            "given_name": "Bill",
102                            "surname": "Smoth"
103                        }
104                    ],
105                    "citizenship": "US",
106                    "birth_details": {
107                        "date_of_birth": "1960-01-01"
108                    },
109                    "phone_numbers": [
110                        {
111                            "type": "WORK",
112                            "country_code": "1",
113                            "national_number": "061511"
114                        }
115                    ],
116                    "identification_documents": [
117                        {
118                            "type": "SOCIAL_SECURITY_NUMBER",
119                            "identification_number": "050-64-9837",
120                            "issuing_country_code": "US"
121                        }
122                    ],
123                    "emails": [
124                        {
125                            "email": "email5@provider.com"
126                        }
127                    ],
128                    "addresses": [
129                        {
130                            "address_line_1": "Campus 611 - 1876",
131                            "address_line_2": "West Seattle",
132                            "admin_area_2": "Seattle",
133                            "admin_area_1": "WA",
134                            "postal_code": "98109",
135                            "country_code": "US",
136                            "type": "HOME"
137                        }
138                    ]
139                }
140            ]
141        },
142        "office_bearers": [
143            {
144                "names": [
145                    {
146                        "given_name": "Another oneaa",
147                        "surname": "Collins",
148                        "id": "KCENS4XYWBBUW",
149                        "type": "LEGAL"
150                    }
151                ],
152                "identification_documents": [
153                    {
154                        "type": "SOCIAL_SECURITY_NUMBER",
155                        "identification_number": "243252871",
156                        "issuing_country_code": "US"
157                    }
158                ],
159                "addresses": [
160                    {
161                        "address_line_1": "Campus 611 - 1876",
162                        "address_line_2": "West Seattle",
163                        "admin_area_2": "Seattle",
164                        "admin_area_1": "WA",
165                        "postal_code": "98109",
166                        "country_code": "US",
167                        "type": "HOME"
168                    }
169                ],
170                "birth_details": {
171                    "date_of_birth": "1990-01-01"
172                },
173                "emails": [
174                    {
175                        "email": "email5@provider.com"
176                    }
177                ],
178                "phone_numbers": [
179                    {
180                        "type": "WORK",
181                        "country_code": "1",
182                        "national_number": "06151188"
183                    }
184                ],
185                "citizenship": "US"
186            }
187        ]
188    },
189    "agreements": [
190        {
191            "type": "TERMS_ACCEPTED",
192            "accepted_time": "2019-06-02T01:23:45Z"
193        }
194    ]
195}

Account with incorrect primary authorized user information

Use case: Create a merchant account with an incorrect primary authorized user name that fails the electronic verification.

Simulation code: The individual_owners.names.given_name for the primary authorized user name must include the word DECLINED.

Sample request
Sample response

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "{{organization}}",
5    "user_id": "{{currentTime}}",
6    "primary_currency_code": "USD",
7    "individual_owners": [
8        {
9            "names": [
10                {
11                    "type": "LEGAL",
12                    "given_name": "MaryDECLINED",
13                    "surname": "Collins"
14                }
15            ],
16            "primary_residence": {
17                "address_line_1": "1234 Lane1 Drive",
18                "admin_area_2": "100",
19                "postal_code": "95014",
20                "country_code": "US"
21            },
22            "birth_details": {
23                "date_of_birth": "1995-05-30"
24            },
25            "phone_numbers": [
26                {
27                    "country_code": "030",
28                    "national_number": "6151175",
29                    "extension_number": "1",
30                    "type": "MOBILE"
31                }
32            ],
33            "emails": [
34                {
35                    "email": "add_email2@provider.com"
36                }
37            ],
38            "citizenship": "US"
39        }
40    ],
41    "business_entity": {
42        "merchant_category_code": 5933,
43        "type": "INDIVIDUAL",
44        "names": [
45            {
46                "type": "LEGAL",
47                "business_name": "Demo"
48            }
49        ],
50        "website_info": {
51            "website_exists": true,
52            "website_url": "www.test.com"
53        }
54    },
55    "agreements": [
56        {
57            "type": "TERMS_ACCEPTED",
58            "accepted_time": "2019-06-02T01:23:45Z"
59        }
60    ]
61}

Account declined by PayPal's risk rules

Use case: Create or update a merchant account with a bank account that PayPal declines due to its risk rules.

Simulation code: The account_holder_details.name must be riskdenied.

POST request
PATCH request

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "FR",
4    "organization": "EU/FR",
5    "individual_owners": [
6        {
7            "agreements": [
8                {
9                    "type": "US_IRS_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",
10                    "accepted_time": "2019-07-31T17:48:58.000Z",
11                    "signature": "Justin Montoya"
12                }
13            ],
14            "names": [
15                {
16                    "type": "LEGAL",
17                    "given_name": "Mary",
18                    "surname": "Collins",
19                    "prefix": "Post",
20                    "middle_name": "Post",
21                    "suffix": "Post"
22                }
23            ],
24            "primary_residence": {
25                "address_line_1": "123 Oak St",
26                "admin_area_2": "San Jose",
27                "postal_code": "95148",
28                "country_code": "FR"
29            },
30            "addresses": [
31                {
32                    "type": "MAILING",
33                    "address_line_1": "mailing address",
34                    "admin_area_2": "LENCHWICK",
35                    "postal_code": "95016",
36                    "country_code": "FR"
37                }
38            ],
39            "phone_numbers": [
40                {
41                    "type": "HOME",
42                    "country_code": "33",
43                    "national_number": "14564567",
44                    "extension_number": "4444"
45                }
46            ],
47            "citizenship": "FR",
48            "birth_details": {
49                "date_of_birth": "1990-01-01"
50            },
51            "emails": [
52                {
53                    "email": "aaa@bbb.com"
54                }
55            ],
56            "identification_documents": [
57                {
58                    "type": "SOCIAL_SECURITY_NUMBER",
59                    "identification_number": "279222343",
60                    "issuing_country_code": "US"
61                }
62            ]
63        }
64    ],
65    "business_entity": {
66        "type": "INDIVIDUAL",
67        "merchant_category_code": "5931",
68        "names": [
69            {
70                "type": "LEGAL",
71                "business_name": "Approved"
72            }
73        ],
74        "website_info": {
75            "website_exists": true,
76            "website_url": "https://www.12345.com"
77        },
78        "addresses": [
79            {
80                "type": "BUSINESS",
81                "address_line_1": "321 Bilge St",
82                "admin_area_2": "San Jose",
83                "postal_code": "95148",
84                "country_code": "FR"
85            }
86        ],
87        "phone_numbers": [
88            {
89                "type": "BUSINESS",
90                "country_code": "33",
91                "national_number": "99998888",
92                "extension_number": "1111"
93            },
94            {
95                "type": "FAX",
96                "country_code": "33",
97                "national_number": "00009999",
98                "extension_number": "6666"
99            }
100        ],
101        "identification_documents": [
102            {
103                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
104                "identification_number": "111234501",
105                "issuing_country_code": "US"
106            }
107        ]
108    },
109    "financial_instruments": {
110        "banks": [
111            {
112                "country_code": "FR",
113                "type": "CHECKING",
114                "account_number": "FR4832000067265147706997584",
115                "account_number_type": "INTERNATIONAL_BANK_ACCOUNT_NUMBER",
116                "currency_code": "EUR",
117                "statement_descriptor": "Testing Shopify Add Bank! Descriptor# US CNTRY",
118                "mandate": {
119                    "consent_to_debit": true
120                },
121                "account_holder_details": {
122                    "name": "riskdenied",
123                    "type": "BUSINESS"
124                }
125            }
126        ]
127    },
128    "agreements": [
129        {
130            "type": "TERMS_ACCEPTED",
131            "accepted_time": "2019-07-11T01:23:45.678Z"
132        }
133    ]
134}

Account with incorrect IBAN code

Use case: Create a merchant account with bank information that includes a faulty International Bank Account Number (IBAN)

Simulation code: The account_holder_details.name must be invalidibancode.

POST request
PATCH request

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "FR",
4    "organization": "EU/FR",
5    "individual_owners": [
6        {
7            "agreements": [
8                {
9                    "type": "US_IRS_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",
10                    "accepted_time": "2019-07-31T17:48:58.000Z",
11                    "signature": "Justin Montoya"
12                }
13            ],
14            "names": [
15                {
16                    "type": "LEGAL",
17                    "given_name": "Mary",
18                    "surname": "Collins",
19                    "prefix": "Post",
20                    "middle_name": "Post",
21                    "suffix": "Post"
22                }
23            ],
24            "primary_residence": {
25                "address_line_1": "123 Oak St",
26                "admin_area_2": "San Jose",
27                "postal_code": "95148",
28                "country_code": "FR"
29            },
30            "addresses": [
31                {
32                    "type": "MAILING",
33                    "address_line_1": "mailing address",
34                    "admin_area_2": "LENCHWICK",
35                    "postal_code": "95016",
36                    "country_code": "FR"
37                }
38            ],
39            "phone_numbers": [
40                {
41                    "type": "HOME",
42                    "country_code": "33",
43                    "national_number": "14564567",
44                    "extension_number": "4444"
45                }
46            ],
47            "citizenship": "US",
48            "birth_details": {
49                "date_of_birth": "1990-01-01"
50            },
51            "emails": [
52                {
53                    "email": "aaa@bbb.com"
54                }
55            ],
56            "identification_documents": [
57                {
58                    "type": "SOCIAL_SECURITY_NUMBER",
59                    "identification_number": "279222343",
60                    "issuing_country_code": "US"
61                }
62            ]
63        }
64    ],
65    "business_entity": {
66        "type": "INDIVIDUAL",
67        "merchant_category_code": "5931",
68        "names": [
69            {
70                "type": "LEGAL",
71                "business_name": "Approved"
72            }
73        ],
74        "website_info": {
75            "website_exists": true,
76            "website_url": "https://www.12345.com"
77        },
78        "addresses": [
79            {
80                "type": "BUSINESS",
81                "address_line_1": "321 Bilge St",
82                "admin_area_2": "San Jose",
83                "postal_code": "95148",
84                "country_code": "FR"
85            }
86        ],
87        "phone_numbers": [
88            {
89                "type": "BUSINESS",
90                "country_code": "33",
91                "national_number": "99998888",
92                "extension_number": "1111"
93            },
94            {
95                "type": "FAX",
96                "country_code": "33",
97                "national_number": "00009999",
98                "extension_number": "6666"
99            }
100        ],
101        "identification_documents": [
102            {
103                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
104                "identification_number": "111234501",
105                "issuing_country_code": "US"
106            }
107        ]
108    },
109    "financial_instruments": {
110        "banks": [
111            {
112                "last_4_digits": "4604",
113                "account_number_type": "INTERNATIONAL_BANK_ACCOUNT_NUMBER",
114                "account_number": "FR0612739000308291151987C48",
115                "account_type": "CHECKING",
116                "routing_number": "4061880319",
117                "currency_code": "EUR",
118                "country_code": "FR",
119                "account_holder_details": {
120                    "name": "invalidibancode"
121                },
122                "bank_name": "Boursorama",
123                "branch_location": "92772 Boulogne-Billancourt FR"
124            }
125        ]
126    },
127    "agreements": [
128        {
129            "type": "TERMS_ACCEPTED",
130            "accepted_time": "2019-07-11T01:23:45.678Z"
131        }
132    ]
133}

Account with blocked routing number

Use case: Create a merchant account with a bank account that has a blocked routing number.

Simulation code: The account_holder_details.name must be badinstrument.

POST request
PATCH request

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "us",
5    "individual_owners": [
6        {
7            "agreements": [
8                {
9                    "type": "US_IRS_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",
10                    "accepted_time": "2019-07-31T17:48:58.000Z",
11                    "signature": "Justin Montoya"
12                }
13            ],
14            "names": [
15                {
16                    "type": "LEGAL",
17                    "given_name": "Mary",
18                    "surname": "Collins",
19                    "prefix": "Post",
20                    "middle_name": "Post",
21                    "suffix": "Post"
22                }
23            ],
24            "primary_residence": {
25                "address_line_1": "123 Oak St",
26                "admin_area_2": "San Jose",
27                "postal_code": "95148",
28                "country_code": "US"
29            },
30            "addresses": [
31                {
32                    "type": "MAILING",
33                    "address_line_1": "mailing address",
34                    "admin_area_2": "LENCHWICK",
35                    "postal_code": "95016",
36                    "country_code": "US"
37                }
38            ],
39            "phone_numbers": [
40                {
41                    "type": "HOME",
42                    "country_code": "33",
43                    "national_number": "14564567",
44                    "extension_number": "4444"
45                }
46            ],
47            "citizenship": "US",
48            "birth_details": {
49                "date_of_birth": "1990-01-01"
50            },
51            "emails": [
52                {
53                    "email": "aaa@bbb.com"
54                }
55            ],
56            "identification_documents": [
57                {
58                    "type": "SOCIAL_SECURITY_NUMBER",
59                    "identification_number": "279222343",
60                    "issuing_country_code": "US"
61                }
62            ]
63        }
64    ],
65    "business_entity": {
66        "type": "INDIVIDUAL",
67        "merchant_category_code": "5931",
68        "names": [
69            {
70                "type": "LEGAL",
71                "business_name": "Approved"
72            }
73        ],
74        "website_info": {
75            "website_exists": true,
76            "website_url": "https://www.12345.com"
77        },
78        "addresses": [
79            {
80                "type": "BUSINESS",
81                "address_line_1": "321 Bilge St",
82                "admin_area_2": "San Jose",
83                "postal_code": "95148",
84                "country_code": "US"
85            }
86        ],
87        "phone_numbers": [
88            {
89                "type": "BUSINESS",
90                "country_code": "33",
91                "national_number": "99998888",
92                "extension_number": "1111"
93            },
94            {
95                "type": "FAX",
96                "country_code": "33",
97                "national_number": "00009999",
98                "extension_number": "6666"
99            }
100        ],
101        "identification_documents": [
102            {
103                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
104                "identification_number": "111234501",
105                "issuing_country_code": "US"
106            }
107        ]
108    },
109    "financial_instruments": {
110        "banks": [
111            {
112                "country_code": "US",
113                "type": "CHECKING",
114                "account_number": "78868666",
115                "account_number_type": "ALL_BANKS",
116                "currency_code": "USD",
117                "routing_number": "074001048",
118                "statement_descriptor": "Testing Shopify Add Bank! Descriptor# US CNTRY",
119                "mandate": {
120                    "consent_to_debit": true
121                },
122                "account_holder_details": {
123                    "name": "badinstrument",
124                    "type": "BUSINESS"
125                }
126            }
127        ]
128    },
129    "agreements": [
130        {
131            "type": "TERMS_ACCEPTED",
132            "accepted_time": "2019-07-11T01:23:45.678Z"
133        }
134    ]
135}

Account with a missing credit capability

Use case: Create a merchant account with a bank account that is blocked for withdrawals due to a lack of credit capability.

Simulation code: The account_holder_details.name must be cannotcredittobank.

POST request
PATCH request

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "FR",
4    "organization": "EU/FR",
5    "individual_owners": [
6        {
7            "agreements": [
8                {
9                    "type": "US_IRS_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",
10                    "accepted_time": "2019-07-31T17:48:58.000Z",
11                    "signature": "Justin Montoya"
12                }
13            ],
14            "names": [
15                {
16                    "type": "LEGAL",
17                    "given_name": "Mary",
18                    "surname": "Collins",
19                    "prefix": "Post",
20                    "middle_name": "Post",
21                    "suffix": "Post"
22                }
23            ],
24            "primary_residence": {
25                "address_line_1": "123 Oak St",
26                "admin_area_2": "San Jose",
27                "postal_code": "95148",
28                "country_code": "FR"
29            },
30            "addresses": [
31                {
32                    "type": "MAILING",
33                    "address_line_1": "mailing address",
34                    "admin_area_2": "LENCHWICK",
35                    "postal_code": "95016",
36                    "country_code": "FR"
37                }
38            ],
39            "phone_numbers": [
40                {
41                    "type": "HOME",
42                    "country_code": "33",
43                    "national_number": "14564567",
44                    "extension_number": "4444"
45                }
46            ],
47            "citizenship": "FR",
48            "birth_details": {
49                "date_of_birth": "1990-01-01"
50            },
51            "emails": [
52                {
53                    "email": "aaa@bbb.com"
54                }
55            ],
56            "identification_documents": [
57                {
58                    "type": "SOCIAL_SECURITY_NUMBER",
59                    "identification_number": "279222343",
60                    "issuing_country_code": "US"
61                }
62            ]
63        }
64    ],
65    "business_entity": {
66        "type": "INDIVIDUAL",
67        "merchant_category_code": "5931",
68        "names": [
69            {
70                "type": "LEGAL",
71                "business_name": "Approved"
72            }
73        ],
74        "website_info": {
75            "website_exists": true,
76            "website_url": "https://www.12345.com"
77        },
78        "addresses": [
79            {
80                "type": "BUSINESS",
81                "address_line_1": "321 Bilge St",
82                "admin_area_2": "San Jose",
83                "postal_code": "95148",
84                "country_code": "FR"
85            }
86        ],
87        "phone_numbers": [
88            {
89                "type": "BUSINESS",
90                "country_code": "33",
91                "national_number": "99998888",
92                "extension_number": "1111"
93            },
94            {
95                "type": "FAX",
96                "country_code": "33",
97                "national_number": "00009999",
98                "extension_number": "6666"
99            }
100        ],
101        "identification_documents": [
102            {
103                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
104                "identification_number": "111234501",
105                "issuing_country_code": "US"
106            }
107        ]
108    },
109    "financial_instruments": {
110        "banks": [
111            {
112                "country_code": "FR",
113                "type": "CHECKING",
114                "account_number": "FR4832000067265147706997584",
115                "account_number_type": "INTERNATIONAL_BANK_ACCOUNT_NUMBER",
116                "currency_code": "EUR",
117                "statement_descriptor": "Testing Shopify Add Bank! Descriptor# US CNTRY",
118                "mandate": {
119                    "consent_to_debit": true
120                },
121                "account_holder_details": {
122                    "name": "cannotcredittobank",
123                    "type": "BUSINESS"
124                }
125            }
126        ]
127    },
128    "agreements": [
129        {
130            "type": "TERMS_ACCEPTED",
131            "accepted_time": "2019-07-11T01:23:45.678Z"
132        }
133    ]
134}

Account with an incorrect bank account number

Use case: Create a merchant account with an incorrect bank account number.

Simulation code: The account_holder_details.name must be instrumentactrestricted.

POST request
PATCH request

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "us",
5    "individual_owners": [
6        {
7            "agreements": [
8                {
9                    "type": "US_IRS_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",
10                    "accepted_time": "2019-07-31T17:48:58.000Z",
11                    "signature": "Justin Montoya"
12                }
13            ],
14            "names": [
15                {
16                    "type": "LEGAL",
17                    "given_name": "Mary",
18                    "surname": "Collins",
19                    "prefix": "Post",
20                    "middle_name": "Post",
21                    "suffix": "Post"
22                }
23            ],
24            "primary_residence": {
25                "address_line_1": "123 Oak St",
26                "admin_area_2": "San Jose",
27                "postal_code": "95148",
28                "country_code": "US"
29            },
30            "addresses": [
31                {
32                    "type": "MAILING",
33                    "address_line_1": "mailing address",
34                    "admin_area_2": "LENCHWICK",
35                    "postal_code": "95016",
36                    "country_code": "US"
37                }
38            ],
39            "phone_numbers": [
40                {
41                    "type": "HOME",
42                    "country_code": "33",
43                    "national_number": "14564567",
44                    "extension_number": "4444"
45                }
46            ],
47            "citizenship": "US",
48            "birth_details": {
49                "date_of_birth": "1990-01-01"
50            },
51            "emails": [
52                {
53                    "email": "aaa@bbb.com"
54                }
55            ],
56            "identification_documents": [
57                {
58                    "type": "SOCIAL_SECURITY_NUMBER",
59                    "identification_number": "279222343",
60                    "issuing_country_code": "US"
61                }
62            ]
63        }
64    ],
65    "business_entity": {
66        "type": "INDIVIDUAL",
67        "merchant_category_code": "5931",
68        "names": [
69            {
70                "type": "LEGAL",
71                "business_name": "Approved"
72            }
73        ],
74        "website_info": {
75            "website_exists": true,
76            "website_url": "https://www.12345.com"
77        },
78        "addresses": [
79            {
80                "type": "BUSINESS",
81                "address_line_1": "321 Bilge St",
82                "admin_area_2": "San Jose",
83                "postal_code": "95148",
84                "country_code": "US"
85            }
86        ],
87        "phone_numbers": [
88            {
89                "type": "BUSINESS",
90                "country_code": "33",
91                "national_number": "99998888",
92                "extension_number": "1111"
93            },
94            {
95                "type": "FAX",
96                "country_code": "33",
97                "national_number": "00009999",
98                "extension_number": "6666"
99            }
100        ],
101        "identification_documents": [
102            {
103                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
104                "identification_number": "111234501",
105                "issuing_country_code": "US"
106            }
107        ]
108    },
109    "financial_instruments": {
110        "banks": [
111            {
112                "country_code": "US",
113                "type": "CHECKING",
114                "account_number": "78868666",
115                "account_number_type": "ALL_BANKS",
116                "currency_code": "USD",
117                "routing_number": "074001048",
118                "statement_descriptor": "Testing Shopify Add Bank! Descriptor# US CNTRY",
119                "mandate": {
120                    "consent_to_debit": true
121                },
122                "account_holder_details": {
123                    "name": "instrumentactrestricted",
124                    "type": "BUSINESS"
125                }
126            }
127        ]
128    },
129    "agreements": [
130        {
131            "type": "TERMS_ACCEPTED",
132            "accepted_time": "2019-07-11T01:23:45.678Z"
133        }
134    ]
135}

Account with multiple failed bank confirmations

Use case: Create a merchant account with a bank account that fails bank confirmation multiple times.

Simulation code: The account_holder_details.name must be maxconfirmationtry.

POST request
PATCH request

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "us",
5    "individual_owners": [
6        {
7            "agreements": [
8                {
9                    "type": "US_IRS_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",
10                    "accepted_time": "2019-07-31T17:48:58.000Z",
11                    "signature": "Justin Montoya"
12                }
13            ],
14            "names": [
15                {
16                    "type": "LEGAL",
17                    "given_name": "Mary",
18                    "surname": "Collins",
19                    "prefix": "Post",
20                    "middle_name": "Post",
21                    "suffix": "Post"
22                }
23            ],
24            "primary_residence": {
25                "address_line_1": "123 Oak St",
26                "admin_area_2": "San Jose",
27                "postal_code": "95148",
28                "country_code": "US"
29            },
30            "addresses": [
31                {
32                    "type": "MAILING",
33                    "address_line_1": "mailing address",
34                    "admin_area_2": "LENCHWICK",
35                    "postal_code": "95016",
36                    "country_code": "US"
37                }
38            ],
39            "phone_numbers": [
40                {
41                    "type": "HOME",
42                    "country_code": "33",
43                    "national_number": "14564567",
44                    "extension_number": "4444"
45                }
46            ],
47            "citizenship": "US",
48            "birth_details": {
49                "date_of_birth": "1990-01-01"
50            },
51            "emails": [
52                {
53                    "email": "aaa@bbb.com"
54                }
55            ],
56            "identification_documents": [
57                {
58                    "type": "SOCIAL_SECURITY_NUMBER",
59                    "identification_number": "279222343",
60                    "issuing_country_code": "US"
61                }
62            ]
63        }
64    ],
65    "business_entity": {
66        "type": "INDIVIDUAL",
67        "merchant_category_code": "5931",
68        "names": [
69            {
70                "type": "LEGAL",
71                "business_name": "Approved"
72            }
73        ],
74        "website_info": {
75            "website_exists": true,
76            "website_url": "https://www.12345.com"
77        },
78        "addresses": [
79            {
80                "type": "BUSINESS",
81                "address_line_1": "321 Bilge St",
82                "admin_area_2": "San Jose",
83                "postal_code": "95148",
84                "country_code": "US"
85            }
86        ],
87        "phone_numbers": [
88            {
89                "type": "BUSINESS",
90                "country_code": "33",
91                "national_number": "99998888",
92                "extension_number": "1111"
93            },
94            {
95                "type": "FAX",
96                "country_code": "33",
97                "national_number": "00009999",
98                "extension_number": "6666"
99            }
100        ],
101        "identification_documents": [
102            {
103                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
104                "identification_number": "111234501",
105                "issuing_country_code": "US"
106            }
107        ]
108    },
109    "financial_instruments": {
110        "banks": [
111            {
112                "country_code": "US",
113                "type": "CHECKING",
114                "account_number": "78868666",
115                "account_number_type": "ALL_BANKS",
116                "currency_code": "USD",
117                "routing_number": "074001048",
118                "statement_descriptor": "Testing Shopify Add Bank! Descriptor# US CNTRY",
119                "mandate": {
120                    "consent_to_debit": true
121                },
122                "account_holder_details": {
123                    "name": "maxconfirmationtry",
124                    "type": "BUSINESS"
125                }
126            }
127        ]
128    },
129    "agreements": [
130        {
131            "type": "TERMS_ACCEPTED",
132            "accepted_time": "2019-07-11T01:23:45.678Z"
133        }
134    ]
135}

Account with a fraudulent bank account number

Use case: Create a merchant account with a fraudulent bank account.

Simulation code: The account_holder_details.name must be blockedinstrument.

POST request
PATCH request

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "US",
4    "organization": "us",
5    "individual_owners": [
6        {
7            "agreements": [
8                {
9                    "type": "US_IRS_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",
10                    "accepted_time": "2019-07-31T17:48:58.000Z",
11                    "signature": "Justin Montoya"
12                }
13            ],
14            "names": [
15                {
16                    "type": "LEGAL",
17                    "given_name": "Mary",
18                    "surname": "Collins",
19                    "prefix": "Post",
20                    "middle_name": "Post",
21                    "suffix": "Post"
22                }
23            ],
24            "primary_residence": {
25                "address_line_1": "123 Oak St",
26                "admin_area_2": "San Jose",
27                "postal_code": "95148",
28                "country_code": "US"
29            },
30            "addresses": [
31                {
32                    "type": "MAILING",
33                    "address_line_1": "mailing address",
34                    "admin_area_2": "LENCHWICK",
35                    "postal_code": "95016",
36                    "country_code": "US"
37                }
38            ],
39            "phone_numbers": [
40                {
41                    "type": "HOME",
42                    "country_code": "33",
43                    "national_number": "14564567",
44                    "extension_number": "4444"
45                }
46            ],
47            "citizenship": "US",
48            "birth_details": {
49                "date_of_birth": "1990-01-01"
50            },
51            "emails": [
52                {
53                    "email": "aaa@bbb.com"
54                }
55            ],
56            "identification_documents": [
57                {
58                    "type": "SOCIAL_SECURITY_NUMBER",
59                    "identification_number": "279222343",
60                    "issuing_country_code": "US"
61                }
62            ]
63        }
64    ],
65    "business_entity": {
66        "type": "INDIVIDUAL",
67        "merchant_category_code": "5931",
68        "names": [
69            {
70                "type": "LEGAL",
71                "business_name": "Approved"
72            }
73        ],
74        "website_info": {
75            "website_exists": true,
76            "website_url": "https://www.12345.com"
77        },
78        "addresses": [
79            {
80                "type": "BUSINESS",
81                "address_line_1": "321 Bilge St",
82                "admin_area_2": "San Jose",
83                "postal_code": "95148",
84                "country_code": "US"
85            }
86        ],
87        "phone_numbers": [
88            {
89                "type": "BUSINESS",
90                "country_code": "33",
91                "national_number": "99998888",
92                "extension_number": "1111"
93            },
94            {
95                "type": "FAX",
96                "country_code": "33",
97                "national_number": "00009999",
98                "extension_number": "6666"
99            }
100        ],
101        "identification_documents": [
102            {
103                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
104                "identification_number": "111234501",
105                "issuing_country_code": "US"
106            }
107        ]
108    },
109    "financial_instruments": {
110        "banks": [
111            {
112                "country_code": "US",
113                "type": "CHECKING",
114                "account_number": "78868666",
115                "account_number_type": "ALL_BANKS",
116                "currency_code": "USD",
117                "routing_number": "074001048",
118                "statement_descriptor": "Testing Shopify Add Bank! Descriptor# US CNTRY",
119                "mandate": {
120                    "consent_to_debit": true
121                },
122                "account_holder_details": {
123                    "name": "blockedinstrument",
124                    "type": "BUSINESS"
125                }
126            }
127        ]
128    },
129    "agreements": [
130        {
131            "type": "TERMS_ACCEPTED",
132            "accepted_time": "2019-07-11T01:23:45.678Z"
133        }
134    ]
135}

Account with blocked routing number and branch code

Use case: Create a merchant account with a bank account with a blocked routing number and branch code combination.

Simulation code: The account_holder_details.name must be branchcodedisabled.

POST request
PATCH request

1{
2    "external_id": "EXT-{{$timestamp}}",
3    "legal_country_code": "ES",
4    "organization": "us",
5    "individual_owners": [
6        {
7            "agreements": [
8                {
9                    "type": "US_IRS_NOT_SUBJECT_TO_US_TAX_CERTIFICATION",
10                    "accepted_time": "2019-07-31T17:48:58.000Z",
11                    "signature": "Justin Montoya"
12                }
13            ],
14            "names": [
15                {
16                    "type": "LEGAL",
17                    "given_name": "Mary",
18                    "surname": "Collins",
19                    "prefix": "Post",
20                    "middle_name": "Post",
21                    "suffix": "Post"
22                }
23            ],
24            "primary_residence": {
25                "address_line_1": "123 Oak St",
26                "admin_area_2": "San Jose",
27                "postal_code": "95148",
28                "country_code": "ES"
29            },
30            "addresses": [
31                {
32                    "type": "MAILING",
33                    "address_line_1": "mailing address",
34                    "admin_area_2": "LENCHWICK",
35                    "postal_code": "95016",
36                    "country_code": "ES"
37                }
38            ],
39            "phone_numbers": [
40                {
41                    "type": "HOME",
42                    "country_code": "33",
43                    "national_number": "14564567",
44                    "extension_number": "4444"
45                }
46            ],
47            "citizenship": "ES",
48            "birth_details": {
49                "date_of_birth": "1990-01-01"
50            },
51            "emails": [
52                {
53                    "email": "aaa@bbb.com"
54                }
55            ],
56            "identification_documents": [
57                {
58                    "type": "SOCIAL_SECURITY_NUMBER",
59                    "identification_number": "279222343",
60                    "issuing_country_code": "US"
61                }
62            ]
63        }
64    ],
65    "business_entity": {
66        "type": "INDIVIDUAL",
67        "merchant_category_code": "5931",
68        "names": [
69            {
70                "type": "LEGAL",
71                "business_name": "Approved"
72            }
73        ],
74        "website_info": {
75            "website_exists": true,
76            "website_url": "https://www.12345.com"
77        },
78        "addresses": [
79            {
80                "type": "BUSINESS",
81                "address_line_1": "321 Bilge St",
82                "admin_area_2": "San Jose",
83                "postal_code": "95148",
84                "country_code": "ES"
85            }
86        ],
87        "phone_numbers": [
88            {
89                "type": "BUSINESS",
90                "country_code": "33",
91                "national_number": "99998888",
92                "extension_number": "1111"
93            },
94            {
95                "type": "FAX",
96                "country_code": "33",
97                "national_number": "00009999",
98                "extension_number": "6666"
99            }
100        ],
101        "identification_documents": [
102            {
103                "type": "EMPLOYER_IDENTIFICATION_NUMBER",
104                "identification_number": "111234501",
105                "issuing_country_code": "US"
106            }
107        ]
108    },
109    "financial_instruments": {
110        "banks": [
111            {
112                "country_code": "ES",
113                "type": "CHECKING",
114                "account_number": "ES5622263801228023506575",
115                "account_number_type": "INTERNATIONAL_BANK_ACCOUNT_NUMBER",
116                "currency_code": "EUR",
117                "routing_number": "4061880319",
118                "statement_descriptor": "Testing Shopify Add Bank! Descriptor# ES CNTRY",
119                "mandate": {
120                    "consent_to_debit": true
121                },
122                "account_holder_details": {
123                    "name": "branchcodedisabled",
124                    "type": "BUSINESS"
125                }
126            }
127        ]
128    },
129    "agreements": [
130        {
131            "type": "TERMS_ACCEPTED",
132            "accepted_time": "2019-07-11T01:23:45.678Z"
133        }
134    ]
135}