Finxera

Back to documentation index

createMerchant

This method allows creating a Merchant ID for each merchant, which is used internally for all the Credit Card transactions done by the client. This Merchant ID is a unique numeric code that has been assigned to the Merchant for Credit Cards transaction processing. The API call creates two accounts - the Merchant Settlement account and the Merchant Reserve Account by default for the Merchant. These accounts are system purpose accounts used for future enhancements and chargeback handling scenarios. The API also creates a Legal entity ID with Litle.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify the Subscriber ID issued, when BancBox account was created
firstName Y Char Enter First Name (Max Length 20)
lastName Y Char Enter Last Name (Max Length 20)
ssn Y String Merchant Social Security Number (format NNN-NN-NNNN, with hyphens as mentioned in the format)
dob Y Date Merchant Date of Birth (YYYY-MM-DD format)
email N String Merchant Email address
+ address Y Object Enter address details
+ bankBusinessAccount Y Object Enter bank business account details
+ merchantDetails Y Object Enter merchant details
+ primaryContact Y Object Enter primary contact details
hasAcceptedCreditCards Y Boolean Select true or false
visaAnnualSalesVolume Y Int Enter the annual Sales volume
organizationType Y N/A Select the Organization type from the Drop Down (INDIVIDUAL_SOLE_PROPRIETORSHIP, CORPORATION, LIMITED_LIABILITY_COMPANY, PARTNERSHIP, ASSOCIATION_ESTATE_TRUST, TAX_EXEMPT_ORGANIZATION, INTERNATIONAL_ORGANIZATION, GOVERNMENT_ORGANIZATION)
taxId Y String Enter the Tax ID(Max Length 9) (Tax ID is mandatory in all the cases except when the organization type is INDIVIDUAL_SOLE_PROPRIETORSHIP)

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)
merchantId   Int It is the ID being created for the merchant
+ warnings   Object A Warning object containing a code and description.
+ errors   Object Request failed, error response.

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><wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsse:UsernameToken wsu:Id="XWSSGID-1261544568770-474929336" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"><wsse:Username>USERNAME</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">PASSWORD</wsse:Password></wsse:UsernameToken></wsse:Security></soapenv:Header>
<soapenv:Body>
<sch:createMerchant>
<createMerchantRequest>
<subscriberId>?</subscriberId>
<firstName>?</firstName>
<lastName>?</lastName>
<ssn>?</ssn>
<dob>?</dob>
<!--Optional:-->
<email>?</email>
<address>
<address1>?</address1>
<!--Optional:-->
<address2>/</address2>
<city>?</city>
<state>?</state>
<zipcode>?</zipcode>
</address>
<bankBusinessAccount>
<routingNumber>?</routingNumber>
<accountNumber>?</accountNumber>
<holderName>?</holderName>
<bankAccountType>?</bankAccountType>
</bankBusinessAccount>
<merchantDetails>
<merchantCategoryCode>?</merchantCategoryCode>
<maxTransactionAmount>?</maxTransactionAmount>
<customerServiceNumber>?</customerServiceNumber>
<!--Optional:-->
<amexId>?</amexId>
<!--Optional:-->
<discoverId>?</discoverId>
<softDescriptor>?</softDescriptor>
</merchantDetails>
<primaryContact>
<firstName>?</firstName>
<lastName>?</lastName>
<phone>?</phone>
<emailAddress>?</emailAddress>
</primaryContact>
<hasAcceptedCreditCards>?</hasAcceptedCreditCards>
<visaAnnualSalesVolume>?</visaAnnualSalesVolume>
<organizationType>?</organizationType>
<!--Optional:-->
<taxId>?</taxId>
</createMerchantRequest>
</sch:createMerchant>
</soapenv:Body>
</soapenv:Envelope>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:createMerchantResponse xmlns:ns1="schema.bancbox.com">
<createMerchantResponse xsi:type="ns3:createMerchantResponse" xmlns:ns3="schema.bancbox.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<requestId>?</requestId>
<status>?</status>
<merchantId>?</merchantId>
</createMerchantResponse>
</ns1:createMerchantResponse>
</soap:Body>
</soap:Envelope>

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

Sample Request

{
    "authentication": {
        "apiKey": "?",
        "secret": "?"
    },
    "subscriberId": ?,
    "firstName": "?",
    "lastName": "?",
    "ssn": "?",
    "dob": "?",
    "email": "?",
    "address": {
        "address1": "?",
        "address2": "?",
        "city": "?",
        "state": "?",
        "zipcode": "?"
    },
    "bankBusinessAccount": {
        "routingNumber": "?",
        "accountNumber": "?",
        "holderName": "?",
        "bankAccountType": "?"
    },
    "merchantDetails": {
        "merchantCategoryCode": "?",
        "maxTransactionAmount": ?,
        "customerServiceNumber": "?",
        "softDescriptor": "?"
    },
    "primaryContact": {
        "firstName": "?",
        "lastName": "?",
        "phone": "?",
        "emailAddress": "?"
    },
    "hasAcceptedCreditCards": ?,
    "visaAnnualSalesVolume": ?,
    "organizationType": "?",
    "taxId": "?"
}

Sample Response

{
   "MerchantId": "?",
   "requestId": ?,
   "status": ?
}

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