Update Sub-merchant

Document created by jordanbarhorst on May 10, 2016Last modified by gjsissons on May 18, 2016
Version 3Show Document
  • View in full screen mode

Return to the list of PayFac API examples

 

You can update the several items associated with a Sub-merchant. To update information associated with a Sub-merchant, you submit a subMerchantUpdateRequest message with the appropriate legalEntityId, subMerchantId, and the updated information.

 

If/when the bank account and routing number of the Sub-merchant changes, it is important that you notify us as soon as possible, so that our required records are always up to date.

 

Also, please consult your Implementation Consultant before updating the American Express Merchant Id (amexMid element) or the Discover Merchant Id (discoverConveyedMid element), since this information has direct impact on transaction processing.

 

You can update the following items:

  •   url
  •   customerServiceNumber
  •   hardCodedBillingDescriptor
  •   maxTransactionAmount
  •   bankRoutingNumber
  •   bankAccountNumber
  •   discoverConveyedMid
  •   eCheckCompanyName
  •   streetAddress1
  •   streetAddress2
  •   city
  •   stateProvince
  •   postalCode
  •   amexMid
  •   eCheckBillingDescriptor

 

Resource Information

 

HTTP method

PUT

Call

/legalentity/legalEntityId/submerchant/subMerchantId

Request format

XML

Response format

XML

Rate limited

Yes

 

PUT parameters

 

Parameter

Required or Optional

Description

legalEntityId

Required

The Id of the Legal Entity

subMerchantId

Required

The Id of the Sub-merchant

 

Example: Update a Sub-merchant Request

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <subMerchantUpdateRequest xmlns="http://psp.litle.com/api/merchant/onboard">
          <amexMid>1234567890</amexMid>
          <discoverConveyedMid>123456789012345</discoverConveyedMid>
          <url>http://merchantUrl</url>
          <customerServiceNumber>8407809000</customerServiceNumber>
          <hardCodedBillingDescriptor>Descriptor</hardCodedBillingDescriptor>
          <maxTransactionAmount>8400</maxTransactionAmount>
          <bankRoutingNumber>840123124</bankRoutingNumber>
          <bankAccountNumber>84012312415</bankAccountNumber>
          <address>
               <streetAddress1>Street Address 1</streetAddress1>
               <streetAddress2>Street Address 2</streetAddress2>
               <city>City</city>
               <stateProvince>MA</stateProvince>
               <postalCode>01970</postalCode>
          </address>
          <primaryContact>
               <firstName>John</firstName>
               <lastName>Doe</lastName>
               <phone>9785552222</phone>
               <emailAddress>John.Doe@company.com</emailAddress>
          </primaryContact>
          <fraud enabled="true"></fraud>
          <amexAcquired enabled="true"></amexAcquired>
          <eCheck enabled="true">
               <eCheckBillingDescriptor>9785552222</eCheckBillingDescriptor>
               <eCheckCompanyName>Your Company Name</eCheckCompanyName>
          </eCheck>
     </subMerchantUpdateRequest>

 

 

Example: Update Sub-Merchant Response

 

<?xml version="1.0" encoding="UTF-8" standalone="true"?>
     <response xmlns="http://psp.litle.com/api/merchant/onboard">
     <transactionId>82820200338801022</transactionId>
</response>

 

See Status Codes and Error Messages

 

Next: Retrieve submerchant

 

Return to the list of PayFac API examples

Attachments

    Outcomes