Update Merchant Details
patch
https://<your_gateway_host>
/api/merchant/:id
Update merchant details
When an update occurs, it will also trigger an update to the processor.
Raw Body
Node.js
1
{
2
"business_information": {
3
"legal": {
4
"name": "PayEngine",
5
"address": "Address",
6
"suite_type": "suite",
7
"suite": "Suite",
8
"zip": 15454,
9
"city": "HCM",
10
"state": "AZ",
11
"phone_no": "9597988888",
12
"fax": ""
13
},
14
"dba": {
15
"name": "PayEngine",
16
"address": "Address",
17
"suite_type": "suite",
18
"suite": "Suite",
19
"zip": 15454,
20
"city": "HCM",
21
"state": "AZ",
22
"phone_no": "9597988888",
23
"fax": ""
24
},
25
"chargeback_type": "other",
26
"charge_back": {
27
"name": "PayEngine",
28
"address": "Address",
29
"suite_type": "suite",
30
"suite": "Suite",
31
"zip": 15454,
32
"city": "HCM",
33
"state": "AZ",
34
"phone_no": "9597988888",
35
"fax": ""
36
},
37
"statement_type": "other",
38
"statement": {
39
"name": "PayEngine",
40
"address": "Address",
41
"suite_type": "suite",
42
"suite": "Suite",
43
"zip": 15454,
44
"city": "HCM",
45
"state": "AZ",
46
"phone_no": "9597988888",
47
"fax": ""
48
},
49
"irs": {
50
"name": "John Doe",
51
"address": "Address",
52
"suite_type": "suite",
53
"suite": "Suite",
54
"zip": 15454,
55
"city": "HCM",
56
"state": "AZ",
57
"reporting_name": "PayEngine",
58
"title": "CEO",
59
"receive_statement": "true",
60
"ownership_type": "CO",
61
"tax_exempt": true,
62
"type_of_tax": "SSN",
63
"tax_identification_number": "295955959",
64
"business_type": "RT",
65
"mcc_sic": "1731",
66
"product_description": "Description"
67
},
68
"email": "[email protected]",
69
"confirm_email": "[email protected]",
70
"customer_service_no": "2959595555",
71
"owned_years": 5,
72
"owned_months": 7,
73
"charge_back_notification": "CLIF",
74
"charge_back_email": "[email protected]",
75
"charge_back_fax": "",
76
"contact": "CONT",
77
"first_name": "John",
78
"last_name": "Doe",
79
"phone_number": "2955556665",
80
"extension": "",
81
"business_bankruptcies": false,
82
"personal_bankruptcies": false
83
},
84
"owner_officer_information": {
85
"officers": [
86
{
87
"owner_type": [
88
"B",
89
"I"
90
],
91
"first_name": "John",
92
"middle_name": "",
93
"last_name": "Doe",
94
"title": "CTR",
95
"us_citizen": true,
96
"ssn": 366666666,
97
"dob": "2008-02-08",
98
"owned_percent": 14,
99
"country": "USA",
100
"street_type": "AC",
101
"street_direction": "E",
102
"street_number": 36366,
103
"street_name": "John Doe",
104
"state": "KY",
105
"zip": 15535,
106
"unit_number": 12345,
107
"phone_no": 3664646666,
108
"email": "[email protected]",
109
"guarantor": false,
110
"do_not_pull": false,
111
"signing_app": true,
112
"city": "New York"
113
}
114
],
115
"do_not_pull": true
116
},
117
"processing_information": {
118
"accept_credit_card": true,
119
"number_of_locations": 4,
120
"merchant_id_number": 3536363636,
121
"processor_name": "PayEngine",
122
"bill_when_shipped": true,
123
"bill_when_shipped_days": "Days02",
124
"refund_policy": "Returns without receipts will result in store credit",
125
"yellow_pages_ind": true,
126
"telemarketing_ind": false,
127
"catalog_ind": false,
128
"word_of_mouth_ind": false,
129
"publications_ind": true,
130
"mailing_ind": false,
131
"internet_ind": false,
132
"other_ind": false,
133
"advertise_internet_address": "",
134
"advertise_internet_email": "",
135
"advertise_other": "",
136
"is_seasonal": false,
137
"jan_ind": false,
138
"feb_ind": false,
139
"mar_ind": false,
140
"apr_ind": false,
141
"may_ind": false,
142
"jun_ind": false,
143
"jul_ind": false,
144
"aug_ind": false,
145
"sep_ind": false,
146
"oct_ind": false,
147
"nov_ind": false,
148
"dec_ind": false,
149
"card_swipe_percent": 25,
150
"manual_keyed_card_present_percent": 25,
151
"manual_keyed_card_not_present_percent": 25,
152
"ecommerce_card_not_present_percent": 25,
153
"b2b_percent": 55,
154
"use_third_party": false,
155
"thid_party_name": "",
156
"thid_party_phone_number": "",
157
"avg_transaction_amount": 5353535,
158
"monthly_sale": 535353535,
159
"exceed_million": false,
160
"receive_marketing_materials": false,
161
"card_type": "All1",
162
"qualified_processing_method": "EDCRetail",
163
"independent_contractors": "Someone"
164
},
165
"banking_information": {
166
"accounts": [
167
{
168
"account_usage": [
169
"DAY",
170
"MON",
171
"CB",
172
"ACHS",
173
"ACHF"
174
],
175
"routing_number": 102000076,
176
"bank_name": "WELLS FARGO BANK NA",
177
"account_number": 242525,
178
"account_number_confirm": 242525,
179
"account_type": "N",
180
"bank_phone_number": "8007452426",
181
"date_opened": "1974-12-12",
182
"bank_contact": "Mr John",
183
"is_default": true
184
}
185
]
186
},
187
"point_of_sale_information": {},
188
"patriot_act": {
189
"type": "business",
190
"government_type": "articles",
191
"business_type": "business",
192
"business_license_name": "John",
193
"business_license_state_of_issuance": "AR",
194
"business_license_date_of_issuance": "2021-02-04",
195
"business_license_expire_date": "2021-02-11",
196
"tax_date_filled": "2021-02-11",
197
"tax_employee_id": 235235523523,
198
"tax_place_of_issuance": "55235235235",
199
"incorporation_place_of_issuance": "New York",
200
"incorporation_date_filled": "2021-02-04",
201
"financial_statement_date": "2021-02-11"
202
},
203
"ach_addendum": {
204
"max_single_transaction_amount": 5000,
205
"max_monthly_transaction_amount": 500000,
206
"max_number_daily_transactions": 1000,
207
"max_number_monthly_transactions": 50000,
208
"web": 25,
209
"tel": 25,
210
"ppd": 25,
211
"ccd": 25
212
},
213
"merchant_site_survey": {
214
"verification_option": "A",
215
"consistent": false
216
}
217
}
Copied!
1
var axios = require('axios');
2
var data = JSON.stringify("your raw data here");
3
​
4
var config = {
5
method: 'patch',
6
url: 'https://{{hostname}}/api/merchant/5aa49cc1-0117-462b-bf15-2049f4ffbac3',
7
headers: {
8
'accept': 'application/json',
9
'Authorization': 'Basic {{publicAPIKey}}',
10
'Content-Type': 'application/json'
11
},
12
data : data
13
};
14
​
15
axios(config)
16
.then(function (response) {
17
console.log(JSON.stringify(response.data));
18
})
19
.catch(function (error) {
20
console.log(error);
21
});
22
​
Copied!
When all required fields have been updated and validated, consider redirecting users to sign their Universal Merchant Agreement document as it will be delivered to the processor as well. Learn more here​
Webhook event: MERCHANT_UPDATED

See also

​
Last modified 1mo ago