Retrieve Sub-merchant

Document created by jordanbarhorst on May 10, 2016Last modified by jordanbarhorst on May 18, 2016
Version 4Show Document
  • View in full screen mode

Return to the list of PayFac API examples

 

If you need to retrieve the latest information on file related to a Sub-merchant for verification purposes, you must perform a GET operation specifying the legalEntityId and subMerchantId. A retrieval request does not require an accompanying XML message.

 

If you are processing transactions only on the Vantiv eCommerce platform and using Dynamic Payout, after creating a Sub-merchant using a value of AUTO_GENERATE for the fundingSubmerchantId, retrieve the assigned fundingSubmerchantId value by submitting a Sub-merchant Retrieval Request.

 

Resource Information

 

HTTP method

GET

Call

/legalentity/legalEntityId/submerchant/subMerchantId

Request format

XML

Response format

XML

Rate limited

Yes

 

PUT parameters

 

Parameter

Required or Optional

Description

legalEntityId

Required

The Id of the Legal Entity

subMerchantId

Required

The Id of the Sub-merchant

 

Example: Retrieval Sub-Merchant Response

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <subMerchantRetrievalResponse xmlns="http://psp.litle.com/api/merchant/onboard">
          <merchantName>Merchant Name</merchantName>
          <amexMid>1234567890</amexMid>
          <discoverConveyedMid>123456789012345</discoverConveyedMid>
          <url>http://merchantUrl.com</url>
          <customerServiceNumber>8407809000</customerServiceNumber>
          <hardCodedBillingDescriptor>billing Descriptor</hardCodedBillingDescriptor>
          <maxTransactionAmount>100000</maxTransactionAmount>
          <purchaseCurrency>USD</purchaseCurrency>
          <merchantCategoryCode>5964</merchantCategoryCode>
          <bankRoutingNumber>840123124</bankRoutingNumber>
          <bankAccountNumber>XXXXX-3124</bankAccountNumber>
          <pspMerchantId>123456</pspMerchantId>
          <fraud enabled="false"/>
          <address>
               <streetAddress1>Street Address 1</streetAddress1>
               <streetAddress2>Street Address 2</streetAddress2>
               <city>City</city>
               <stateProvince>MA</stateProvince>
               <postalCode>01970</postalCode>
               <countryCode>USA</countryCode>
          </address>
          <primaryContact>
               <firstName>John</firstName>
               <lastName>Doe</lastName>
               <phone>9785552222</phone>
               <emailAddress>John.Doe@company.com</emailAddress>
          </primaryContact>
          <eCheck enabled="true">
               <eCheckCompanyName>Your Company Name</eCheckCompanyName>
               <eCheckBillingDescriptor>9785552222</eCheckBillingDescriptor>
          </eCheck>
          <subMerchantFunding enabled="true">
               <fundingSubmerchantId>12345678901234</fundingSubmerchantId>
          </subMerchantFunding>
          <subMerchantId>88899966655544433</subMerchantId>
          <amexSellerId>12345678901234</amexSellerId>
          <disabled>true or false</disabled>
          <transactionId>82820200338801105</transactionId>
          <merchantIdentString>011000022</merchantIdentString>
          <credentials>
               <userName>UserName</userName>
               <password>Password</password>
               <passwordExpirationDate>2015-10-30T11:18:23.127-04:00</passwordExpirationDate>
          </credentials>
          <paypageCredentials>
               <paypageCredential>
               <userName>PSPxm1V8</userName>
               <paypageId>Asd23thI974Jpk32</paypageId>
          </paypageCredential>
          <paypageCredential>
               <userName>PSPxm1V8Two</userName>
               <paypageId>odzhgcbQX3e3EaKV</paypageId>
          </paypageCredential>
          <paypageCredential>
               <userName>PSPxm1V8Three</userName>
               <paypageId>qmnpUBM6G47YJAcq</paypageId>
          </paypageCredential>
     </paypageCredentials>
     <updateDate>2015-04-30T11:18:23.127-04:00</updateDate>
</subMerchantRetrievalResponse>

 

 

See Status Codes and Error Messages

 

Next: Retrieve allowed MCC list

 

Return to the list of PayFac API examples

Attachments

    Outcomes