Finxera

Back to documentation index

getMerchant

Use the getMerchant API to get information of a specific merchant.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify the Subscriber ID issued, when BancBox account was created
merchantId Y Int Specify Id of the Merchant whose status has to be changed

Response Parameters

  Parameter   Type Description
requestId   Long 13 digit ID for the API request being made
status   Int It is the Status of completed request, (1 for pass or 0 for fail)
+ warnings   Object A Warning object containing a code and description.
+ errors   Object Request failed, error response.
+ Merchant   Object Merchant details

WSDL URL (Production) :  https://api.bancbox.com/v3/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v3/BBXPort?wsdl

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:getMerchant>
         <getMerchantRequest>
            <subscriberId>?</subscriberId>
            <merchantId>?</merchantId>
         </getMerchantRequest>
      </sch:getMerchant>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:getMerchantResponse>
         <getMerchantResponse>
            <!--Optional:-->
            <requestId>?</requestId>
            <status>?</status>
            <!--Zero or more repetitions:-->
            <warnings>
               <!--Optional:-->
               <code>?</code>
               <!--Optional:-->
               <message>?</message>
            </warnings>
            <!--Zero or more repetitions:-->
            <errors>
               <!--Optional:-->
               <code>?</code>
               <!--Optional:-->
               <message>?</message>
            </errors>
            <!--Optional:-->
            <Merchant>
               <!--Optional:-->
               <merchantId>?</merchantId>
               <!--Optional:-->
               <firstName>?</firstName>
               <!--Optional:-->
               <lastName>?</lastName>
               <!--Optional:-->
               <middleInitial>?</middleInitial>
               <!--Optional:-->
               <ssn>?</ssn>
               <!--Optional:-->
               <dob>?</dob>
               <!--Optional:-->
               <address>
                  <address1>?</address1>
                  <!--Optional:-->
                  <address2>?</address2>
                  <city>?</city>
                  <state>?</state>
                  <zipcode>?</zipcode>
               </address>
               <!--Optional:-->
               <email>?</email>
               <!--Optional:-->
               <MerchantStatus>?</MerchantStatus>
               <!--Optional:-->
               <bankBusinessAccount>
                  <routingNumber>?</routingNumber>
                  <accountNumber>?</accountNumber>
                  <holderName>?</holderName>
                  <bankAccountType>?</bankAccountType>
               </bankBusinessAccount>
               <!--Optional:-->
               <modifiedOn>?</modifiedOn>
               <!--Optional:-->
               <modifiedBy>?</modifiedBy>
               <!--Optional:-->
               <createdOn>?</createdOn>
               <!--Optional:-->
               <createdBy>?</createdBy>
            </Merchant>
         </getMerchantResponse>
      </sch:getMerchantResponse>
   </soapenv:Body>
</soapenv:Envelope>

Note:For REST, Content-type should be set to application/json
URL (Production) :  https://api.bancbox.com/v3/BBXPortRest/getMerchant
URL (SandBox) :  https://sandbox-api.bancbox.com/v3/BBXPortRest/getMerchant

Sample Request

{
 "authentication":
 {
  "apiKey":"",
  "secret":""
 },
    "subscriberId":,
    "merchantId":
}

Sample Response

{
   "Merchant":    {
      "firstName": "",
      "lastName": "",
      "ssn": "",
      "dob": "",
      "address":       {
         "address1": "",
         "city": "",
         "state": "",
         "zipcode": ""
      },
      "MerchantStatus": "",
      "bankBusinessAccount":       {
         "routingNumber": "",
         "accountNumber": "",
         "holderName": "",
         "bankAccountType": ""
      },
      "createdOn": "",
      "createdBy": ""
   },
   "requestId":,
   "status": ,
   "warnings":,
   "errors": 
}

Note: This is a beta version. The api listed here are likely to change.