# Update merchant Endpoint: PATCH /v1/merchants/{merchant_id} Version: v1 Security: account-secret ## Path parameters: - `merchant_id` (string, required) ## Request fields (application/json): - `legal_business_name` (string, required) - `legal_phone` (string, required) - `business_phone` (string) - `business_type` (string, required) - `bank_account` (object, required) - `bank_account.bank_name` (string, required) - `bank_account.routing_number` (string, required) - `bank_account.account_holder_name` (string, required) - `bank_account.account_number` (string, required) - `bank_account.account_number_confirm` (string, required) - `tin` (string, required) - `tin_type` (string, required) Enum: "EIN", "SSN", "ITIN" - `doing_business_as` (string) - `business_established_date` (string, required) - `legal_business_address` (object, required) - `legal_business_address.address` (string, required) - `legal_business_address.city` (string, required) - `legal_business_address.state` (string, required) - `legal_business_address.zip` (string, required) - `dba_address` (object) - `owner_one` (object, required) - `owner_one.first_name` (string, required) - `owner_one.last_name` (string, required) - `owner_one.middle_name` (string) - `owner_one.job_title` (string, required) - `owner_one.ownership_percentage` (string, required) - `owner_one.email` (string, required) - `owner_one.date_of_birth` (string, required) - `owner_one.home_address` (object, required) - `owner_one.ssn` (string, required) - `owner_two` (object) - `owner_three` (object) - `owner_four` (object) - `main_product` (object, required) - `main_product.description` (string, required) - `main_product.category` (string, required) - `main_product.subcategory` (string, required) - `main_product.website` (string, required) - `main_contact_person` (object, required) - `main_contact_person.name` (string, required) - `current_sales` (object, required) - `current_sales.average_monthly_in_credit_card` (string, required) - `current_sales.average_ticket_value` (string, required) - `current_sales.highest_amount_to_date` (string, required) - `current_sales.sales_percentage` (object, required) - `current_sales.sales_percentage.card_swipe_percentage` (string, required) - `current_sales.sales_percentage.moto_percentage` (string, required) - `current_sales.sales_percentage.online_percentage` (string, required) - `current_sales.sales_percentage.keyed_percentage` (string, required) - `current_sales.average_amex_monthly_sales` (string, required) - `current_sales.average_amex_ticket_value` (string, required) - `bank_account_results` (string) - `capabilities` (object) Capabilities settings - `capabilities.types` (array) Array of capability types Enum: "two_tiered", "pass_through_ic", "flat_rate", "tiered", "cash_discount", "ach" - `capabilities.options` (object) Capability options for each type Example: {"two_tiered":{"vmd_cp_rate_percent":"2.00","vmd_cp_fee_fixed":"0.10","vmd_cnp_rate_percent":"2.50","vmd_cnp_fee_fixed":"0.15","amex_cp_rate_percent":"3.10","amex_cp_fee_fixed":"0.25","amex_cnp_rate_percent":"3.50","amex_cnp_fee_fixed":"0.30"},"ach":{"txn_fee_percent":"1.50","txn_fee_fixed":"0.25"}} - `capabilities.options.two_tiered` (object) Example: {"vmd_cp_rate_percent":"2.00","vmd_cp_fee_fixed":"0.10","vmd_cnp_rate_percent":"2.50","vmd_cnp_fee_fixed":"0.15","amex_cp_rate_percent":"3.10","amex_cp_fee_fixed":"0.25","amex_cnp_rate_percent":"3.50","amex_cnp_fee_fixed":"0.30"} - `capabilities.options.pass_through_ic` (object) - `capabilities.options.flat_rate` (object) - `capabilities.options.tiered` (object) - `capabilities.options.cash_discount` (object) - `capabilities.options.ach` (object) Example: {"txn_fee_percent":"1.50","txn_fee_fixed":"0.25"} ## Response 200 fields (application/json): - `id` (string, required) Example: "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k" - `phone` (string, required) Example: "12819374192" - `automatic_payouts` (boolean, required) Merchant payouts status - `deactivated` (boolean, required) Merchant deactivation flag - `created_at` (string, required) - `lead_id` (number, required) Onboarding application ID - `lead_onboarding_status` (string, required) Merchant onboarding status Enum: "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "APPROVED", "FAILED" - `merchant` (object, required) Merchant onboarding information - `merchant.legal_business_name` (string, required) - `merchant.legal_phone` (string, required) - `merchant.business_phone` (string) - `merchant.business_type` (string, required) - `merchant.bank_account` (object, required) - `merchant.bank_account.bank_name` (string, required) - `merchant.bank_account.routing_number` (string, required) - `merchant.bank_account.account_holder_name` (string, required) - `merchant.bank_account.account_number` (string, required) - `merchant.bank_account.account_number_confirm` (string, required) - `merchant.tin` (string, required) - `merchant.tin_type` (string, required) Enum: "EIN", "SSN", "ITIN" - `merchant.doing_business_as` (string) - `merchant.business_established_date` (string, required) - `merchant.legal_business_address` (object, required) - `merchant.legal_business_address.address` (string, required) - `merchant.legal_business_address.city` (string, required) - `merchant.legal_business_address.state` (string, required) - `merchant.legal_business_address.zip` (string, required) - `merchant.dba_address` (object) - `merchant.owner_one` (object, required) - `merchant.owner_one.first_name` (string, required) - `merchant.owner_one.last_name` (string, required) - `merchant.owner_one.middle_name` (string) - `merchant.owner_one.job_title` (string, required) - `merchant.owner_one.ownership_percentage` (string, required) - `merchant.owner_one.email` (string, required) - `merchant.owner_one.date_of_birth` (string, required) - `merchant.owner_one.home_address` (object, required) - `merchant.owner_one.ssn` (string, required) - `merchant.owner_two` (object) - `merchant.owner_three` (object) - `merchant.owner_four` (object) - `merchant.main_product` (object, required) - `merchant.main_product.description` (string, required) - `merchant.main_product.category` (string, required) - `merchant.main_product.subcategory` (string, required) - `merchant.main_product.website` (string, required) - `merchant.main_contact_person` (object, required) - `merchant.main_contact_person.name` (string, required) - `merchant.current_sales` (object, required) - `merchant.current_sales.average_monthly_in_credit_card` (string, required) - `merchant.current_sales.average_ticket_value` (string, required) - `merchant.current_sales.highest_amount_to_date` (string, required) - `merchant.current_sales.sales_percentage` (object, required) - `merchant.current_sales.sales_percentage.card_swipe_percentage` (string, required) - `merchant.current_sales.sales_percentage.moto_percentage` (string, required) - `merchant.current_sales.sales_percentage.online_percentage` (string, required) - `merchant.current_sales.sales_percentage.keyed_percentage` (string, required) - `merchant.current_sales.average_amex_monthly_sales` (string, required) - `merchant.current_sales.average_amex_ticket_value` (string, required) - `merchant.bank_account_results` (string) - `merchant.capabilities` (object) Capabilities settings - `merchant.capabilities.types` (array) Array of capability types Enum: "two_tiered", "pass_through_ic", "flat_rate", "tiered", "cash_discount", "ach" - `merchant.capabilities.options` (object) Capability options for each type Example: {"two_tiered":{"vmd_cp_rate_percent":"2.00","vmd_cp_fee_fixed":"0.10","vmd_cnp_rate_percent":"2.50","vmd_cnp_fee_fixed":"0.15","amex_cp_rate_percent":"3.10","amex_cp_fee_fixed":"0.25","amex_cnp_rate_percent":"3.50","amex_cnp_fee_fixed":"0.30"},"ach":{"txn_fee_percent":"1.50","txn_fee_fixed":"0.25"}} - `merchant.capabilities.options.two_tiered` (object) Example: {"vmd_cp_rate_percent":"2.00","vmd_cp_fee_fixed":"0.10","vmd_cnp_rate_percent":"2.50","vmd_cnp_fee_fixed":"0.15","amex_cp_rate_percent":"3.10","amex_cp_fee_fixed":"0.25","amex_cnp_rate_percent":"3.50","amex_cnp_fee_fixed":"0.30"} - `merchant.capabilities.options.pass_through_ic` (object) - `merchant.capabilities.options.flat_rate` (object) - `merchant.capabilities.options.tiered` (object) - `merchant.capabilities.options.cash_discount` (object) - `merchant.capabilities.options.ach` (object) Example: {"txn_fee_percent":"1.50","txn_fee_fixed":"0.25"} - `payment` (object, required) Merchant payment information - `payment.tokenizer_publishable_key` (string, required) Public key used for tokenizer Example: "pub_XXXXXXXXXXXXXX" - `payment.terminal_id` (string, required) Terminal ID Example: "Cx78a65ada9" - `defaults` (object, required) Merchant default settings - `defaults.displayName` (string, required) Display name for the merchant Example: "My Store" - `defaults.logo` (string, required) Logo URL for the merchant Example: "https://example.com/logo.png" - `defaults.primaryColor` (string, required) Primary color for merchant branding Example: "#FF5733" - `defaults.secondaryColor` (string, required) Secondary color for merchant branding Example: "#FF5733" - `defaults.redirectUrl` (string) URL to redirect after completing a transaction Example: "https://merchant-site.com/thank-you" - `defaults.customDomain` (string) Custom domain for merchant onboarding Example: "https://apply.example.com" - `default_capabilities` (object, required) Account default capabilities - `default_capabilities.types` (array, required) Capability types Enum: "two_tiered", "pass_through_ic", "flat_rate", "tiered", "cash_discount", "ach" - `default_capabilities.options` (object, required) Capability options - `default_capabilities.options.two_tiered` (object, required) Two-tiered payment capabilities - `default_capabilities.options.two_tiered.vmd_cp_rate_percent` (string, required) Visa/Mastercard card present rate percent Example: "2.00" - `default_capabilities.options.two_tiered.vmd_cp_fee_fixed` (string, required) Visa/Mastercard card present fee fixed Example: "0.10" - `default_capabilities.options.two_tiered.vmd_cnp_rate_percent` (string, required) Visa/Mastercard card not present rate percent Example: "2.50" - `default_capabilities.options.two_tiered.vmd_cnp_fee_fixed` (string, required) Visa/Mastercard card not present fee fixed Example: "0.15" - `default_capabilities.options.two_tiered.amex_cp_rate_percent` (string, required) Amex card present rate percent Example: "3.10" - `default_capabilities.options.two_tiered.amex_cp_fee_fixed` (string, required) Amex card present fee fixed Example: "0.25" - `default_capabilities.options.two_tiered.amex_cnp_rate_percent` (string, required) Amex card not present rate percent Example: "3.50" - `default_capabilities.options.two_tiered.amex_cnp_fee_fixed` (string, required) Amex card not present fee fixed Example: "0.30" - `default_capabilities.options.pass_through_ic` (object, required) Pass-through IC payment capabilities - `default_capabilities.options.pass_through_ic.processor_markup_percent` (string, required) Processor markup percent Example: "0.10" - `default_capabilities.options.pass_through_ic.transaction_fee_fixed` (string, required) Transaction fee fixed Example: "0.10" - `default_capabilities.options.pass_through_ic.vmd_credit_discount_percent` (string, required) Visa/Mastercard credit discount percent - `default_capabilities.options.pass_through_ic.vmd_credit_fee_fixed` (string, required) Visa/Mastercard credit fee fixed - `default_capabilities.options.pass_through_ic.vmd_debit_discount_percent` (string, required) Visa/Mastercard debit discount percent - `default_capabilities.options.pass_through_ic.vmd_debit_fee_fixed` (string, required) Visa/Mastercard debit fee fixed - `default_capabilities.options.pass_through_ic.amex_discount_percent` (string, required) Amex discount percent - `default_capabilities.options.pass_through_ic.amex_fee_fixed` (string, required) Amex fee fixed - `default_capabilities.options.flat_rate` (object, required) Flat rate payment capabilities - `default_capabilities.options.flat_rate.rate_percent` (string, required) Flat rate percent Example: "2.90" - `default_capabilities.options.flat_rate.fee_fixed` (string, required) Fee fixed Example: "0.30" - `default_capabilities.options.flat_rate.vmd_credit_rate_percent` (string, required) Visa/Mastercard credit rate percent - `default_capabilities.options.flat_rate.vmd_debit_rate_percent` (string, required) Visa/Mastercard debit rate percent - `default_capabilities.options.flat_rate.amex_rate_percent` (string, required) Amex rate percent - `default_capabilities.options.tiered` (object, required) Tiered payment capabilities - `default_capabilities.options.tiered.vmd_qual_credit_rate_percent` (string, required) Visa/Mastercard qualified credit rate percent Example: "1.79" - `default_capabilities.options.tiered.vmd_midq_credit_rate_percent` (string, required) Visa/Mastercard mid-qualified credit rate percent Example: "2.19" - `default_capabilities.options.tiered.vmd_midq_credit_fee_fixed` (string, required) Visa/Mastercard mid-qualified credit fee fixed Example: "0.15" - `default_capabilities.options.tiered.vmd_nonq_credit_rate_percent` (string, required) Visa/Mastercard non-qualified credit rate percent Example: "3.25" - `default_capabilities.options.tiered.vmd_nonq_credit_fee_fixed` (string, required) Visa/Mastercard non-qualified credit fee fixed Example: "0.20" - `default_capabilities.options.tiered.vmd_qual_debit_rate_percent` (string, required) Visa/Mastercard qualified debit rate percent Example: "1.50" - `default_capabilities.options.tiered.vmd_midq_debit_rate_percent` (string, required) Visa/Mastercard mid-qualified debit rate percent Example: "1.90" - `default_capabilities.options.tiered.vmd_midq_debit_fee_fixed` (string, required) Visa/Mastercard mid-qualified debit fee fixed Example: "0.12" - `default_capabilities.options.tiered.vmd_nonq_debit_rate_percent` (string, required) Visa/Mastercard non-qualified debit rate percent Example: "2.95" - `default_capabilities.options.tiered.vmd_nonq_debit_fee_fixed` (string, required) Visa/Mastercard non-qualified debit fee fixed Example: "0.18" - `default_capabilities.options.tiered.amex_qual_credit_rate_percent` (string, required) Amex qualified credit rate percent Example: "2.89" - `default_capabilities.options.tiered.amex_midq_credit_rate_percent` (string, required) Amex mid-qualified credit rate percent Example: "3.29" - `default_capabilities.options.tiered.amex_midq_credit_fee_fixed` (string, required) Amex mid-qualified credit fee fixed Example: "0.25" - `default_capabilities.options.tiered.amex_nonq_credit_rate_percent` (string, required) Amex non-qualified credit rate percent Example: "4.35" - `default_capabilities.options.tiered.amex_nonq_credit_fee_fixed` (string, required) Amex non-qualified credit fee fixed Example: "0.30" - `default_capabilities.options.tiered.qualified_rate_percent` (string, required) Qualified rate percent (legacy) Example: "1.79" - `default_capabilities.options.tiered.qualified_fee_fixed` (string, required) Qualified fee fixed (legacy) Example: "0.10" - `default_capabilities.options.tiered.mid_qualified_rate_percent` (string, required) Mid-qualified rate percent (legacy) Example: "2.19" - `default_capabilities.options.tiered.mid_qualified_fee_fixed` (string, required) Mid-qualified fee fixed (legacy) Example: "0.15" - `default_capabilities.options.tiered.non_qualified_rate_percent` (string, required) Non-qualified rate percent (legacy) Example: "3.25" - `default_capabilities.options.tiered.non_qualified_fee_fixed` (string, required) Non-qualified fee fixed (legacy) Example: "0.20" - `default_capabilities.options.cash_discount` (object, required) Cash discount payment capabilities - `default_capabilities.options.cash_discount.enabled` (boolean, required) Is cash discount enabled Example: true - `default_capabilities.options.ach` (object, required) ACH payment capabilities - `default_capabilities.options.ach.txn_fee_fixed` (string, required) ACH transaction fixed fee Example: "0.25" - `default_capabilities.options.ach.txn_fee_percent` (string, required) ACH transaction percentage fee Example: "0.75" - `default_capabilities.options.ach.return_fee_fixed` (string, required) ACH return fixed fee Example: "5.00" - `default_capabilities.options.ach.chargeback_fee_fixed` (string, required) ACH chargeback fixed fee Example: "10.00"