Return to the list of PayFac® API examples
You use the Create Legal Entity Agreement request transaction to designate the version of the agreement along with information about the agreeing party. You should use this transaction type only if your PayFac Account Manager directs you to do so.
To create a Legal Entity Agreement, use an HTTP POST method to submit the legalEntityAgreementCreateRequest message.
Resource information
HTTP method | POST |
Call | /legalentity/legalEntityId/agreement |
Request format | XML |
Response format | XML |
Rate limited | No |
POST parameters
Parameter | Required or Optional | Description |
legalEntityId | Required | The Id of the Legal Entity |
Example: Create Legal Entity Agreement Request
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<legalEntityAgreementCreateRequest xmlns="
http://psp.litle.com/api/merchant/onboard
">
<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-11T12:00:00-06:00</acceptanceDateTime>
</legalEntityAgreement>
</legalEntityAgreementCreateRequest>
The structure for the response to a Create Legal Entity Agreement request has the following structure.
<legalEntityAgreementCreateResponse>
<transactionId>1234567890123456789</transactionId>
</legalEntityAgreementCreateResponse>
If the create request is a duplicate, the response message includes a duplicate=”true” attribute.
If the request fails, the system returns an error response. See Status Codes and Error Messages
Next: Legal entity agreement retrieval request