Update Legal Entity

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 Legal Entity. To update information associated with a Legal Entity, you submit a legalEntityUpdateRequest message with the appropriate legalEntityId and the updated information.

 

You can update the following items:

  •   streetAddress1 (entity and/or principal)
  •   streetAddress2 (entity and/or principal)
  •   city (entity and/or principal)
  •   stateProvince (entity and/or principal)
  •   postalCode (entity and/or principal)
  •   doingBusinessAs
  •   annualCreditCardSalesVolume
  •   hasAcceptedCreditCards
  •   contactPhone (entity and/or principal)
  •   title (principal)
  •   emailAddress (principal)
  •   firstName (principal)
  •   lastName (principal)
  •   ssn (principal)
  •   dateOfBirth (principal)
  •   driversLicense (principal)
  •   driversLicenseState (principal)
  •   legalEntityName
  •   legalEntityType
  •   taxId
  •   yearsInBusiness

 

HTTP method

PUT

Call

/legalentity/legalEntityId

Request format

XML

Response format

XML

Rate limited

Yes

 

PUT parameters

 

Parameter

Required or Optional

Description

legalEntityId

Required

The Id of the Legal Entity

 

Example: Update Legal Entity Request

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <legalEntityUpdateRequest xmlns="http://psp.litle.com/api/merchant/onboard">
          <address>
               <streetAddress1>LE Street Address 1</streetAddress1>
               <streetAddress2>LE Street Address 2</streetAddress2>
               <city>LE City</city>
               <stateProvince>MA</stateProvince>
               <postalCode>01730</postalCode>
               <countryCode>USA</countryCode>
          </address>
          <contactPhone>9785550101</contactPhone>
          <doingBusinessAs>Other Name Co.</doingBusinessAs>
          <annualCreditCardSalesVolume>10000000</annualCreditCardSalesVolume>
          <hasAcceptedCreditCards>true</hasAcceptedCreditCards>
          <principal>
               <title>CEO</title>
               <emailAddress>jdoe@mail.net</emailAddress>
               <contactPhone>9785551234</contactPhone>
               <address>
                    <streetAddress1>p street address 1</streetAddress1>
                    <streetAddress2>p street address 2</streetAddress2>
                    <city>Boston</city>
                    <stateProvince>MA</stateProvince>
                    <postalCode>01890</postalCode>
                    <countryCode>USA</countryCode>
               </address>
               <backgroundCheckFields>
                    <firstName>p first</firstName>
                    <lastName>p last</lastName>
                    <ssn>123459876</ssn>
                    <dateOfBirth>1980-10-12</dateOfBirth>
                    <driversLicense>892327409832</driversLicense>
                    <driversLicenseState>MA</driversLicenseState>
               </backgroundCheckFields>
          </principal>
          <backgroundCheckFields>
               <legalEntityName>Company Name</legalEntityName>
               <legalEntityType>LE Type Enum</legalEntityType>
               <taxId>123456789</taxId>
          </backgroundCheckFields>
          <yearsInBusiness>10</yearsInBusiness>
     </legalEntityUpdateRequest>

 

 

Update Legal Entity Response

 

The system replies to an Update Legal Entity request with a generic response message. The structure of the response message is as follows:

 

<legalEntityResponse>
     <transactionId>1234567890123456789</transactionId>
     <legalEntityId> (appears if first request of dupe with all matching data)
     <responseCode>
     <responseDescription>
     <originalLegalEntity> (appears if dupe)
     <backgroundCheckResults> (appears if background check triggered by update)
</legalEntityResponse>

 

See Status codes and error messages

 

Next: Retrieve legal entity

 

Return to list of PayFac API examples

Attachments

    Outcomes