Finxera

Back to documentation index

updateMerchantStatus

Use the updateMerchantStatus API to change/ update the status of a merchant. The updateMerchantStatus API either enables or disables a merchant, as per the request.

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
merchantStatus Y String Select one from {Active, Inactive, Closed}

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 Warning
+ errors   Object Error
merchantId   Int Merchant Id
merchantStatus   String Updated status of the merchant

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:updateMerchantStatus>
         <updateMerchantStatusRequest>
            <subscriberId>?</subscriberId>
            <merchantId>?</merchantId>
            <merchantStatus>?</merchantStatus>
         </updateMerchantStatusRequest>
      </sch:updateMerchantStatus>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:updateMerchantStatusResponse>
         <merchantStatusResponse>
            <!--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:-->
            <merchantId>?</merchantId>
            <!--Optional:-->
            <merchantStatus>?</merchantStatus>
         </merchantStatusResponse>
      </sch:updateMerchantStatusResponse>
   </soapenv:Body>
</soapenv:Envelope>

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

Sample Request

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

Sample Response

{
   "merchantId":,
   "merchantStatus": "",
   "requestId":,
   "status": ,
   "warnings": null,
   "errors": null
}

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