Update merchant accounts

DocsCURRENT

Last updated: Oct 23rd, 9:07pm

As part of managing a merchant account, throughout the merchant account’s lifecycle, you may have to update the merchant’s business and bank information. Merchant information is typically updated to, 

  • Rectify information entered during the initial onboarding.  
  • Accommodate changes in critical business information, such as addresses and owners. 

Merchant bank information is typically updated to modify the bank account or financial instrument details the merchant provides during onboarding. 

Available PATCH operations

The following tables show the merchant account fields that can be updated through PATCH operations and the updates permitted after KYC completion.

Individual Owner

Field Patch path Patch operation Allowed post-KYC?
Names /individual_owners/@id=='{individual-owner-id}'/names/@id=='{name-id}' replace No
/individual_owners/@id=='{individual-owner-id}'/names add No
/individual_owners/@id=='{individual-owner-id}'/names/- add No
Phone Numbers /individual_owners/@id=='{individual-owner-id}'/phone_numbers/@id=='{phone-number-id}' replace Yes
/individual_owners/@id=='{individual-owner-id}'/phone_numbers/@id=='{phone-number-id}' remove Yes
/individual_owners/@id=='{individual-owner-id}'/phone_numbers replace Yes
/individual_owners/@id=='{individual-owner-id}'/phone_numbers add Yes
/individual_owners/@id=='{individual-owner-id}'/phone_numbers/- add Yes
/individual_owners/@id=='{individual-owner-id}'/phone_numbers remove Yes
Addresses /individual_owners/@id=='{individual-owner-id}'/addresses/- (with type set to HOME) or /individual_owners/@id=='{individual-owner-id}'/primary_residence add No
/individual_owners/@id=='{individual-owner-id}'/addresses/@id=='{home-address-id}' or /individual_owners/@id=='{individual-owner-id}'/primary_residence replace No
/individual_owners/@id=='{individual-owner-id}'/addresses/@id=='{home-address-id}' or /individual_owners/@id=='{individual-owner-id}'/primary_residence remove No
/individual_owners/@id=='{individual-owner-id}'/addresses/- (with type set to MAILING) add Yes
/individual_owners/@id=='{individual-owner-id}'/addresses/@id=='{mailing-address-id}' replace Yes
/individual_owners/@id=='{individual-owner-id}'/addresses/@id=='{mailing-address-id}' remove Yes
/individual_owners/@id=='{individual-owner-id}'/addresses replace No
/individual_owners/@id=='{individual-owner-id}'/addresses add No
Emails /individual_owners/@id=='{individual-owner-id}'/emails/- add Yes
/individual_owners/@id=='{individual-owner-id}'/emails/@id=='{email-id}' replace Yes
/individual_owners/@id=='{individual-owner-id}'/emails/@id=='{email-id}' remove Yes
Country of Primary Citizenship /individual_owners/@id=='{individual-owner-id}'/citizenship add Yes
/individual_owners/@id=='{individual-owner-id}'/citizenship replace No
Birth Details /individual_owners/@id=='{individual-owner-id}'/birth_details add Yes
/individual_owners/@id=='{individual-owner-id}'/birth_details replace No
Identification Documents /individual_owners/@id=='{individual-owner-id}'/identification_documents/@id=='{identification-document-id}' replace No
/individual_owners/@id=='{individual-owner-id}'/identification_documents replace No
/individual_owners/@id=='{individual-owner-id}'/identification_documents add Yes
/individual_owners/@id=='{individual-owner-id}'/identification_documents/- add Yes
Occupation /individual_owners/@id=='{individual-owner-id}'/occupation add Yes
/individual_owners/@id=='{individual-owner-id}'/occupation replace Yes

Business Entity

Field Patch path Patch operation Allowed post-KYC?
Names /business_entity/names/@id=='{business-name-id}' replace Yes
/business_entity/names/@id=='{business-name-id}' remove Yes
/business_entity/names replace Yes
/business_entity/names add Yes
/business_entity/names/- add Yes
Merchant Category Code /business_entity/merchant_category_code replace Yes
/business_entity/merchant_category_code add Yes
Website Info /business_entity/website add Yes
/business_entity/website replace Yes
/business_entity/website remove Yes
/business_entity/website_info add Yes
/business_entity/website_info replace Yes
Phone numbers /business_entity/phone_numbers/@id=='{phone-number-id}' replace Yes
/business_entity/phone_numbers/@id=='{phone-number-id}' remove Yes
/business_entity/phone_numbers replace Yes
/business_entity/phone_numbers add Yes
/business_entity/phone_numbers/- add Yes
Addresses /business_entity/addresses/- (with type set to BUSINESS) or /business_entity/registered_business_address add No
/business_entity/addresses/@id=='{registered-business-address-id}' or /business_entity/registered_business_address replace No
/business_entity/addresses replace No
/business_entity/addresses add No
/business_entity/addresses/@id=='{mailing-address-id}' or /business_entity/addresses/@id=='{office-address-id}' replace Yes
/business_entity/addresses/@id=='{mailing-address-id}' or /business_entity/addresses/@id=='{office-address-id}' remove Yes
/business_entity/addresses/- (with type set to MAILING or OFFICE) add Yes
Emails /business_entity/emails/@id=='{email-address-id}' replace Yes
/business_entity/emails/@id=='{email-address-id}' remove Yes
/business_entity/emails replace Yes
/business_entity/emails add Yes
/business_entity/emails/- add Yes
Incorporation Country /business_entity/incorporation_details/incorporation_country_code add Yes
/business_entity/incorporation_details/incorporation_country_code replace Yes
Business Type /business_entity/type replace No
Identification Documents /business_entity/identification_documents/@id=='{identification-document-id}' replace No
/business_entity/identification_documents replace No
/business_entity/identification_documents add No
/business_entity/identification_documents/- add No
25% Beneficial Owner Declaration /business_entity/declarations/@name=='TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER'/value add Yes
/business_entity/declarations/@name=='TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER'/value replace Yes
Declarations /business_entity/declarations/- add Yes
/business_entity/declarations/- replace Yes

Office Bearers

Field Patch path Patch operation Allowed post-KYC?
Office Bearers /business_entity/office_bearers/- add Yes
/business_entity/office_bearers add Yes
/business_entity/office_bearers remove Yes
/business_entity/office_bearers replace Yes
/business_entity/office_bearers/@id=='{office-bearer-id}' remove Yes
/business_entity/office_bearers/@id=='{office-bearer-id}' replace Yes
Names /business_entity/office_bearers/@id=='{office-bearer-id}'/names add Yes
/business_entity/office_bearers/@id=='{office-bearer-id}'/names replace Yes
Addresses /business_entity/office_bearers/@id=='{office-bearer-id}'/addresses add Yes
/business_entity/office_bearers/@id=='{office-bearer-id}'/addresses replace Yes
Country of Primary Citizenship /business_entity/office_bearers/@id=='{office-bearer-id}'/citizenship add Yes
/business_entity/office_bearers/@id=='{office-bearer-id}'/citizenship replace Yes
Birth Details /business_entity/office_bearers/@id=='{office-bearer-id}'/birth_details add Yes
/business_entity/office_bearers/@id=='{office-bearer-id}'/birth_details replace Yes
Identification Documents /business_entity/office_bearers/@id=='{office-bearer-id}'/identification_documents add Yes
/business_entity/office_bearers/@id=='{office-bearer-id}'/identification_documents replace Yes
Emails /business_entity/office_bearers/@id=='{office-bearer-id}'/emails add Yes
/business_entity/office_bearers/@id=='{office-bearer-id}'/emails replace Yes
Phone Numbers /business_entity/office_bearers/@id=='{office-bearer-id}'/phone_numbers add Yes
/business_entity/office_bearers/@id=='{office-bearer-id}'/phone_numbers replace Yes
Role /business_entity/office_bearers/@id=='{office-bearer-id}'/role add Yes
/business_entity/office_bearers/@id=='{office-bearer-id}'/role replace Yes

Beneficial Owners

Field Patch path Patch operation Allowed post-KYC?
Beneficial Owners /business_entity/beneficial_owners/individuals add Yes
/business_entity/beneficial_owners/individuals remove Yes
/business_entity/beneficial_owners/individuals replace Yes
/business_entity/beneficial_owners/individuals/- add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}' remove Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}' replace Yes
Names /business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/names add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/names replace Yes
Addresses /business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/addresses add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/addresses replace Yes
Country of Primary Citizenship /business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/citizenship add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/citizenship replace Yes
Birth Details /business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/birth_details add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/birth_details replace Yes
Identification Documents /business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/identification_documents add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/identification_documents replace Yes
Emails /business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/emails add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/emails replace Yes
Phone Numbers /business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/phone_numbers add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/phone_numbers replace Yes
Percentage of Ownership /business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/percentage_of_ownership add Yes
/business_entity/beneficial_owners/individuals/@id=='{beneficial-owner-id}'/percentage_of_ownership replace Yes

Account

Field Patch path Patch operation Allowed post-KYC?
Soft Descriptor /soft_descriptor replace Yes
Agreements /agreements/- add Yes
/agreements/@type=='TERMS_ACCEPTED' replace Yes
/agreements/@type=='TERMS_ACCEPTED' add Yes
Attributes /attributes add Yes
Wallet Domains /wallet_domains add Yes
/wallet_domains/@id=='{wallet-domain-id}' remove Yes

Financial Instruments

Field Patch path Patch operation Allowed post-KYC?
Bank Accounts /financial_instruments/banks add Yes
/financial_instruments/banks replace Yes
/financial_instruments/banks/- add Yes
/financial_instruments/banks/@id=='{bank-account-id}' replace Yes

Know more

  • For information on how to use a PATCH call and update your merchant’s business information, see Update merchant information.  
  • For information on how to use a PATCH call and update your merchant’s bank information, see Update bank information
  • For information on how to test the updates to your merchant account, see Test in sandbox.