payfac-mp-sdk-python

The PayFac Merchant Provisioner SDK is a Java implementation of the Worldpay PayFac Merchant Provisioner API. This SDK was created to make it as easy as possible to perform operations that allows you 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. This SDK utilizes the HTTPS protocol to securely connect to Worldpay. Using the SDK requires coordination with the Vantiv eCommerce team in order to be provided with credentials for accessing our systems.

Each Python SDK release supports all of the functionality present in the associated PayFac Merchant Provisioner API version (e.g., SDK v13.0.0 supports API v13.0.0). Please see our documentation for PayFac Merchant Provisioner API to get more details on what operations are supported.

This SDK is implemented to support the Python programming language and is created by Worldpay. Its intended use is for PayFac API operations with Worldpay.

Getting Started

These instructions will help you get started with using the SDK.

Dependencies

Setup

To download and install:

Using pip

pip install PayFacMpSdk

Without Pip

# Clone repo
git clone https://github.com/Vantiv/payfac-mp-sdk-python.git
# Cd to repo
cd payfac-mp-sdk-python
# Checkout latest branch 13.x
git checkout 13.x
# Run the setup file
python setup.py install

setup configurations

payfac_mp_sdk_setup

Configuration

List of configuration parameters along with their values can be found here.

Usage example

#Example for PayFac MP SDK
from __future__ import print_function, unicode_literals

from payfacMpSdk import *
from dateutil.parser import parse

# Initial Configuration object. If you have saved configuration in '.payfac_mp_sdk.conf' at system environment
# variable: PAYFAC_MP_SDK_CONFIG or user home directory, the saved configuration will be automatically load.
conf = utils.Configuration()

# Configuration need following attributes for payfac-mp requests:
# user = ''
# password = ''
# merchantId = ''
# url = 'https://www.testvantivcnp.com/sandbox/payfac'
# proxy = ''

# Retrieving information about a payfac-mp by legalEntityId:

response = payfac_legalEntiy.get_by_legalEntityId(xxxx)
response = payfac_agreement.get_by_legalEntityId("1000293")


# Post a new payfac-mp case

legalEntityAgreementCreateRequest = generatedClass.legalEntityAgreementCreateRequest.factory()
legalEntityAgreement = generatedClass.legalEntityAgreement.factory()
legalEntityAgreement.set_legalEntityAgreementType("MERCHANT_AGREEMENT")
legalEntityAgreement.set_agreementVersion("agreementVersion1")
legalEntityAgreement.set_userFullName("userFullName")
legalEntityAgreement.set_userSystemName("systemUserName")
legalEntityAgreement.set_userIPAddress("196.198.100.100")
legalEntityAgreement.set_manuallyEntered("false")
legalEntityAgreement.set_acceptanceDateTime(parse("2017-02-11T12:00:00-06:00"))
legalEntityAgreementCreateRequest.set_legalEntityAgreement(legalEntityAgreement)

response = payfac_agreement.post_by_legalEntityId("21003",legalEntityAgreementCreateRequest)


# Update payfac-mp case

subMerchantUpdateRequest = generatedClass.subMerchantUpdateRequest.factory()
subMerchantUpdateRequest.set_amexMid("1234567890")
subMerchantUpdateRequest.set_discoverConveyedMid("123456789012345")
subMerchantUpdateRequest.set_url("http://merchantUrl")
subMerchantUpdateRequest.set_customerServiceNumber("8407809000")
subMerchantUpdateRequest.set_hardCodedBillingDescriptor("Descriptor")
subMerchantUpdateRequest.set_maxTransactionAmount(8400)
subMerchantUpdateRequest.set_bankRoutingNumber("840123124")
subMerchantUpdateRequest.set_bankAccountNumber("84012312415")
subMerchantUpdateRequest.set_pspMerchantId("785412365")
subMerchantUpdateRequest.set_purchaseCurrency("USD")
address = generatedClass.addressUpdatable.factory()
address.set_streetAddress1("Street Address 1")
address.set_streetAddress2("Street Address 2")
address.set_city("City")
address.set_stateProvince("MA")
address.set_postalCode("01970")
subMerchantUpdateRequest.set_address(address)
primaryContact = generatedClass.subMerchantPrimaryContactUpdatable.factory()
primaryContact.set_firstName("John")
primaryContact.set_lastName("Doe")
primaryContact.set_phone("978555222")
subMerchantUpdateRequest.set_primaryContact(primaryContact)
fraud = generatedClass.subMerchantFraudFeature.factory()
fraud.set_enabled("true")
subMerchantUpdateRequest.set_fraud(fraud)
amexAcquired = generatedClass.subMerchantAmexAcquiredFeature.factory()
amexAcquired.set_enabled("true")
subMerchantUpdateRequest.set_amexAcquired(amexAcquired)
eCheck = generatedClass.subMerchantECheckFeature.factory()
eCheck.set_eCheckBillingDescriptor("978555222")
eCheck.set_enabled("true")
subMerchantUpdateRequest.set_eCheck(eCheck)

response = payfac_submerchant.put_by_subMerchantId("2018","123456", subMerchantUpdateRequest)

Versioning

For the versions available, see the tags on this repository.

Changelog

For the list of changes, check out the changelog

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Examples

More examples can be found in Functional and Unit Tests

Support

Please contact Vantiv eCommerce to receive valid merchant credentials in order to run tests successfully or if you require assistance in any way. Support can also be reached at sdksupport@Vantiv.com