Update Merchant Details
Update merchant details
PATCH https://<PayEngine-host>/merchant/:id
Update a merchant by setting the values of the parameters passed. Any parameters not provided are left unchanged. IMPORTANT: Always check the valid criteria for each section below with the Onboarding Criteria API first.
Path Parameters
id*
string
Merchant ID
Request Body
external_id
string
An optional identifier from your system to associate with this merchant
business_details*
object
The business information section is always required. This contains general information about the merchant business. Information collected in this section would be items, such as legal and DBA (doing business as) names of the merchant, business entity types, MCC/SIC codes, address, contact information, description of products or services sold, etc.
owner_officers*
object
The Owner/Officer section is always required. This is used to collect information on all beneficial owners of the business/merchant being onboarded.
credit_card_processing
object
Required if merchant is set to accept credit cards.
bank_details
object
If new bank information for this merchant needs to be added.
business_type*
object
Business Type
ach_processing
object
Required if merchant is set to accept ACH transactions
fee_schedule_id
string
If a different fee schedule is required for this merchant other than what's setup as default.
validate
boolean
Indicates whether the validation of the onboarding application is required or not. Validation results are returned in the update response. It's false by default.
{
"message": "merchant updated",
"data": {
"id": "d6399869-747c-4537-9c04-f81ce2a6c5eb",
"created_at": "2022-03-07T16:40:24.213Z",
"updated_at": "2022-03-07T16:40:24.213Z",
"account_id": "3cab79a6-31bd-43e6-9a0c-e5870b18fa38",
"email": "[email protected]",
"status": "editing",
"external_id": "ID123",
"name": "New Merchant 1646671371",
"data": {
"name": "New Merchant 1646671371",
"email": "[email protected]",
"business_type": {
"type": "COS",
"mcc_sic": "5734"
},
"business_details": {
"legal": {
"name": "New Merchant 1646671371",
"address_street": "123 Main Street",
"suite_type": "suite",
"address_unit": "222",
"address_city": "Los Angeles",
"address_state": "CA",
"address_zip": 92808
},
"dba_same_as_legal": true,
"business_phone_no": "7526463989",
"email": "[email protected]",
"business_age_years": 1,
"business_age_months": 2,
"business_description": "Description of products or services sold",
"how_products_delivered": "Directly to consumer's home",
"when_product_received": "2-3 business days",
"return_policy": "Return before 30 days",
"tax_exempt": false,
"type_of_tax_id": "SSN",
"tax_identification_number": "222334456",
"accepted_transaction_types": [
"ACH"
],
"number_of_locations": "4",
"company_annual_revenue": "1000000",
"how_many_days": "3",
"place_of_issuance": "CA",
"aoi_month": 4,
"aoi_year": "2020",
"aoi_day": 22,
"b2b_percentage": "20",
"dba": {
"name": "New Merchant 1646671371",
"address_street": "123 Main Street",
"suite_type": "suite",
"address_city": "Los Angeles",
"address_state": "CA",
"address_zip": 92808
}
},
"owner_officers": {
"officers": [
{
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"ownership": 75,
"address_same_as_legal": false,
"address_street": "Main Street",
"address_unit": "",
"address_city": "Los Angeles",
"address_state": "CA",
"address_zip": "90245",
"email": "[email protected]",
"phone_no": "3494262452",
"birth_month": 2,
"birth_day": 28,
"birth_year": 1990,
"ssn": "333445567",
"title": "CEO",
"signing_app": true,
"personal_guarantor": true,
"country_of_citizenship": "USA"
}
]
},
"credit_card_processing": {
"card_swiped": 25,
"manually_keyed_cp": 25,
"manually_keyed_cnp": 25,
"ecommerce": 25,
"accept_cc_before": false,
"previous_processor_name": "Global Processor",
"avg_transaction_amount": 25,
"total_monthly_sales": 10000,
"highest_transaction_amount": 25,
"frequency_ticket_per_year": "25",
"qualified_processing_method": "EDCRetail"
},
"ach_processing": {
"max_check_amount": "1000",
"avg_check_amount": "30",
"max_monthly_transaction_amount": 25,
"min_monthly_transaction_amount": 25,
"max_daily_transactions_count": 25,
"max_monthly_transactions_count": 25,
"total_annual_amount": 25,
"web": 25,
"tel": 25,
"ppd": 25,
"ccd": 25
}
},
"feeschedule_id": "e88c756f-5667-4a3c-a9f9-346446da71b1"
}
}{
"name": "PayEngine",
"email": "[email protected]",
"business_type": {
"type": "PR",
"mcc_sic": "5734"
},
"business_details": {
"legal": {
"name": "PayEngine",
"address_street": "Address",
"address_unit": "suite",
"address_city": "HCM",
"address_state": "AZ",
"address_zip": 15454
},
"dba": {
"name": "PayEngine",
"address_street": "Address",
"address_unit": "suite",
"address_city": "HCM",
"address_state": "AZ",
"address_zip": 15454
},
"dba_same_as_legal": true,
"business_phone_no": "7526463989",
"email": "[email protected]",
"business_age_years": 1,
"business_age_months": 2,
"business_description": "Description of products or services sold",
"how_products_delivered": "Directly to consumer's home",
"return_policy": "Return before 30 days",
"tax_exempt": false,
"type_of_tax_id": "SSN",
"tax_identification_number": "353535355",
"accepted_transaction_types": [
"CC_DC",
"ACH"
],
"number_of_locations": "1",
"company_annual_revenue": 1000000,
"place_of_issuance": "CA",
"aoi_day": 20,
"aoi_month": 2,
"aoi_year": 2020,
"how_many_days": "2-3 business days",
"b2b_percentage": 70
},
"credit_card_processing": {
"card_swiped": 25,
"manually_keyed_cp": 25,
"manually_keyed_cnp": 25,
"ecommerce": 25,
"accept_cc_before": true,
"previous_processor_name": "CC Processor",
"avg_transaction_amount": 25,
"total_monthly_sales": 10000,
"highest_transaction_amount": 25,
"frequency_ticket_per_year": "25",
"qualified_processing_method": "EDCRetail"
},
"ach_processing": {
"max_check_amount": "1000",
"avg_check_amount": "30",
"max_monthly_transaction_amount": 25,
"min_monthly_transaction_amount": 25,
"max_daily_transactions_count": 25,
"max_monthly_transactions_count": 25,
"total_annual_amount": 25,
"avg_number_checks_monthly": "3000",
"est_monthly_check_volume": "30000",
"web": 25,
"tel": 25,
"ppd": 25,
"ccd": 25
},
"owner_officers": {
"current_index": -1,
"officers": [
{
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"ownership": 75,
"address_same_as_legal": false,
"address_street": "Main Street",
"address_unit": "",
"address_city": "Los Angeles",
"address_state": "CA",
"address_zip": "90245",
"email": "[email protected]",
"phone_no": "3494262452",
"birth_month": 2,
"birth_day": 28,
"birth_year": 1990,
"ssn": "353535355",
"title": "CEO",
"signing_app": true,
"personal_guarantor": true,
"country_of_citizenship": "USA"
}
]
},
"bank_details": {
"accounts": [
{
"account_name": "My Bank Account",
"account_type": "N",
"routing_number": "083908420",
"account_number": "12345678"
}
]
},
"fee_schedule_id": "e88c756f-5667-4a3c-a9f9-346446da71b1"
}See also
Application section criteriaGet bank auto fillLast updated