Test in sandbox

DocsCurrent

Last updated: Oct 18th, 5:09am

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.

Additionally, you can test responses by creating accounts with incorrect bank accounts. The default state for onboarding bank accounts in the sandbox is Happy Path because we cannot verify test data. To test negative scenarios, use a simulation keyword for the specific use case, as shown in the following examples:

Use case scenarios and simulation codes

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

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}