Merchant Management API
Vantiv’s PayFac API is used for merchant management. It is an XML based, RESTful API that allows developers to create and update Legal Entities and Sub-merchants, as well as retrieve information about existing Legal Entities and Sub-merchants in near real-time. Additionally, developers can use the API to disable Sub-merchants should the need arise. The API is used for PayFacs boarded to Vantiv's eCommerce platform
Before you can begin processing payment transactions for a Sub-merchant, you must first create the Legal Entity. A Legal Entity describes the parent of one or more Sub-merchants. After the successful creation of a Legal Entity, you create Sub-merchants under that Legal Entity.
The PayFac API should not be confused with Vantiv’s APIs for processing payment transactions. The PayFac API is only used to manage legal entitles and sub-merchants.
Example - Using the PayFac API to Create a Legal Entity Agreement
<?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>126.96.36.199</userIPAddress> <manuallyEntered>false</manuallyEntered> <acceptanceDateTime>2015-02-11T12:00:00-06:00</acceptanceDateTime> </legalEntityAgreement> </legalEntityAgreementCreateRequest>
When you use the PayFac API to create a Legal Entity and/or a Sub-merchant, the system performs a series of background checks.
The extent and type of check performed depend upon your needs and contract.
There are three levels of service available: Basic, Premium, and Premium Plus. You can learn more about the legal entity acceptance flow for each of these service levels by consulting the PayFac API Reference Guide.