Legal Entity Agreement Retrieval Request

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 use the Legal Entity Agreement Retrieval request to retrieve all agreements associated with a specified Legal Entity.

 

To retrieve all agreements associated with a Legal Entity use an HTTP GET method to submit the legalEntityAgreementCreateRequest message.

 

Resource information

 

HTTP method

GET

Call

/legalentity/legalEntityId/agreement

Request format

XML

Response format

XML

Rate limited

No

 

GET parameters

 

Parameter

Required or Optional

Description

legalEntityId

Required

The Id of the Legal Entity

 

Example: Legal Entity Agreement Response (no agreements)

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <legalEntityAgreementRetrievalResponse xmlns="http://psp.litle.com/api/merchant/onboard">
          <legalEntityId>82826972905308177</legalEntityId>
          <transactionId>82826972904898673</transactionId>
          <agreements/>
     </legalEntityAgreementRetrievalResponse>

 

 

Example: Legal Entity Agreement Response (with agreements)

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<legalEntityAgreementRetrievalResponse xmlns="http://psp.litle.com/api/merchant/onboard">
     <legalEntityId>82826972905308177</legalEntityId>
     <transactionId>82826972904898673</transactionId>
     <agreements>
           <legalEntityAgreement>
                <legalEntityAgreementType>MERCHANT_AGREEMENT</legalEntityAgreementType>
               <agreementVersion>agreementVersion1</agreementVersion>
               <userFullName>userFullName</userFullName>
               <userSystemName>systemUserName</userSystemName>
               <userIPAddress>196.198.100.100</userIPAddress>
               <manuallyEntered>false</manuallyEntered>
               <acceptanceDateTime>2015-02-11T13:00:00-05:00</acceptanceDateTime>
          </legalEntityAgreement>
          <legalEntityAgreement>
               <legalEntityAgreementType>MERCHANT_AGREEMENT</legalEntityAgreementType>
               <agreementVersion>agreementVersion4</agreementVersion>
               <userFullName>userFullNameFour</userFullName>
               <userSystemName>systemUserNameFour</userSystemName>
               <userIPAddress>199.12.15.201</userIPAddress>
               <manuallyEntered>false</manuallyEntered>
               <acceptanceDateTime>2015-02-24T02:59:30-05:00</acceptanceDateTime>
          </legalEntityAgreement>
          <legalEntityAgreement>
               <legalEntityAgreementType>MERCHANT_AGREEMENT</legalEntityAgreementType>
               <agreementVersion>agreementVersion3</agreementVersion>
               <userFullName>userFullNameThree</userFullName>
               <userSystemName>systemUserNameThree</userSystemName>
               <userIPAddress>210.13.154.155</userIPAddress>
               <manuallyEntered>false</manuallyEntered>
               <acceptanceDateTime>2015-02-23T01:59:30-05:00</acceptanceDateTime>
          </legalEntityAgreement>
          <legalEntityAgreement>
               <legalEntityAgreementType>MERCHANT_AGREEMENT</legalEntityAgreementType>
               <agreementVersion>agreementVersion2</agreementVersion>
               <userFullName>userFullNameTwo</userFullName>
               <userSystemName>systemUserNameTwo</userSystemName>
               <manuallyEntered>true</manuallyEntered>
               <acceptanceDateTime>2015-02-19T23:59:30-05:00</acceptanceDateTime>
          </legalEntityAgreement>
     </agreements>
</legalEntityAgreementRetrievalResponse>

 

See Status Codes and Error Messages

 

Next: Create legal entity

 

Return to the list of PayFac API examples

Attachments

    Outcomes