Colombia Marketplace APIs
POST Pricing/Acquiring v2
# Don't forget to add your HMAC Authorization Headers
data = {
"companyId": 10222,
"settlementMethodId":"104",
"clientTariffId":"001051",
"serviceId":"201",
"merchantTariffId":"001011"
}
endpoint = "/marketplace/v2/pricing/acquiring"
r = requests.post(url + endpoint, json=data, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/marketplace/v2/pricing/acquiring"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
"companyId": 10222,
"settlementMethodId":"104",
"clientTariffId":"001051",
"serviceId":"201",
"merchantTariffId":"001011"
}' $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = { method: 'POST',
url: url + '/marketplace/v2/pricing/acquiring',
headers: getAuthenticationHeaders(),
body: {
"companyId": 10222,
"settlementMethodId":"104",
"clientTariffId":"001051",
"serviceId":"201",
"merchantTariffId":"001011"
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
try {
String jsonString = "{\n" +
" \"companyId\": 10222,\n" +
" \"settlementMethodId\": \"104\",\n" +
" \"clientTariffId\": \"001051\",\n" +
" \"serviceId\": \"201\",\n" +
" \"merchantTariffId\": \"001011\",\n" +
"}";
StringEntity payload = new StringEntity(jsonString);
HttpResponse response = doPost("/marketplace/v2/pricing/acquiring", payload);
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
JSONArray json = new JSONArray(response_string);
System.out.println("json:" + json.toString());
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$data = {
"companyId": 10222,
"settlementMethodId":"104",
"clientTariffId":"001051",
"serviceId":"201",
"merchantTariffId":"001011"
};
$data_json = json_encode($data);
$headers = array(
'date: ' . $date,
'Authorization: ' . $hmacAuth,
'Content-Type: application/json',
'Content-Length: ' . strlen($data_json)
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/marketplace/v2/pricing/acquiring");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_json);
$res = curl_exec($ch);
echo($res);
?>
The above command returns JSON structured like this:
{
"productPricingResponses": [
{
"pricingDetailId": 63050,
"pricingTypeId": 335703,
"productId": "2010008000000022",
"feeMinAbsolute": 0,
"feeMin": 0,
"feeDefault": 0,
"feeMax": 0,
"feeMaxAbsolute": 0,
"minAmountAbsolute": 0,
"minAmt": 0,
"defaultAmt": 0,
"maxAmt": 0,
"maxAmountAbsolute": 0,
"quantity": 1,
"rateMinAbsolute": 0,
"rateMin": 0,
"rateDefault": 0,
"rateMax": 0,
"rateMaxAbsolute": 0,
"productName": "Service Fee",
"productType": "Service Fee",
"isOverride": false,
"override": false,
"showoncart": false,
"occurrence": {
"type": "Bancolombia"
},
"merchantTariffId": "001011"
},
{
"pricingDetailId": 63051,
"pricingTypeId": 335703,
"productId": "2010008000000023",
"feeMinAbsolute": 0,
"feeMin": 0,
"feeDefault": 0,
"feeMax": 0,
"feeMaxAbsolute": 0,
"minAmountAbsolute": 0,
"minAmt": 0,
"defaultAmt": 0,
"maxAmt": 0,
"maxAmountAbsolute": 0,
"quantity": 1,
"rateMinAbsolute": 0,
"rateMin": 0,
"rateDefault": 0,
"rateMax": 0,
"rateMaxAbsolute": 0,
"productName": "Service Fee",
"productType": "Service Fee",
"isOverride": false,
"override": false,
"showoncart": false,
"occurrence": {
"type": "All"
},
"merchantTariffId": "001011"
},
{
"pricingDetailId": 63114,
"pricingTypeId": 335703,
"productId": "2010008000000024",
"feeMinAbsolute": 0,
"feeMin": 0,
"feeDefault": 0,
"feeMax": 0,
"feeMaxAbsolute": 0,
"minAmountAbsolute": 0,
"minAmt": 0,
"defaultAmt": 0,
"maxAmt": 0,
"maxAmountAbsolute": 0,
"quantity": 1,
"rateMinAbsolute": 0,
"rateMin": 0,
"rateDefault": 0,
"rateMax": 0,
"rateMaxAbsolute": 0,
"productName": "Service Fee",
"productType": "Service Fee",
"isOverride": false,
"override": false,
"showoncart": false,
"occurrence": {
"type": "All"
},
"merchantTariffId": "001011"
}
]
}
Retrieve the acquiring product Ids for a given settlementMethodId, clienttariffId, merchanttariffId, and serviceId combination. These Ids will be used when setting pricing at the location level in the POST Business Info API call.
Request
POST /marketplace/v2/pricing/acquiring
| Parameter | Required | Data Type | Description |
|---|---|---|---|
| companyId | ✔ | long | Company Identifier. |
| settlementMethodId | ✔ | string | The settlement method assigned to the merchant’s service contract. The settlement method controls the allowed settlement instructions to be applicable for this merchant. Possible Values: "019", "104". |
| clientTariffId | ✔ | string | The client tariff assigned to the merchant. A client tariff is a way of distinguishing controls between merchants within the same service contract. This allows separate account fees to be configured. |
| serviceId | ✔ | string | The acquiring service against which the charge will apply. Possible Values: "201", "203", "101", "114", "107", "406", "119". |
| merchantTariffId | ✔ | string | The pricing mechanism applied to the fee. Possible Values: "001011", "000313". |
| cardNotPresent | integer | Card not present. | |
| transactionInfo | object | Contains mccTypes, mcc, annualVolume, annualcardVolume, averageTicket, amexVolume, amexMemberId, highestTicket and category. | |
| mccTypes | string | MCC Type. | |
| mcc | string | Merchant category code, also known as standard industry code (SIC). | |
| annualVolume | double | Annual Volume. | |
| annualcardVolume | double | Annual Card Volume. | |
| averageTicket | double | Average Ticket. | |
| amexVolume | double | Amex Volume. | |
| amexMemberId | long | Amex Member Id. | |
| highestTicket | double | Highest Ticket. | |
| category | string | Category. | |
| cartdetails | array | List of cart details. Contains productId, category and productType. | |
| productId | long | Product Id. | |
| category | string | Category. | |
| productType | string | Product Type. |
Response
This API returns an array of objects, each representing a “Pricing Product.” Each object contains the following keyword-value pairs.
| Parameter | Data Type | Description |
|---|---|---|
| pricingDetailId | long | Pricing detail ID. |
| pricingTypeId | long | Pricing type id. |
| productId | long | Product Id. |
| description | string | Short description of the product. |
| feeMinAbsolute | double | Minimum Absolute Fee. |
| feeMin | double | Minimum fee. |
| feeDefault | double | Default fee. |
| feeMax | double | Maximum Fee. |
| feeMaxAbsolute | double | Maximum Absolute fee. |
| minAmountAbsolute | double | Minimum Absolute Fee. |
| minAmt | double | Minimum Amount. |
| defaultAmt | double | Default Amount. |
| maxAmt | double | Maximum Amount. |
| maxAmountAbsolute | double | Maximum Absolute Amount. |
| quantity | integer | Quantity. |
| rateMinAbsolute | double | Rate Minimum Absolute. |
| rateMin | double | Rate Minimum. |
| rateDefault | double | Rate Default. |
| rateMax | double | Rate Maximum. |
| rateMaxAbsolute | double | Rate Maximum Absolute. |
| productName | string | Product Name. |
| productType | string | Product Type. |
| isOverride | boolean | Flag isOverride. |
| override | boolean | Flag override. |
| showoncart | boolean | Flag to show on cart ‘true or false’. |
| occurrence | object | Contains type. |
| type | string | Type of occurrence. |
| groupName | string | Group name of products. |
| parentOrder | long | Parent Order. |
| clientTariffId | string | Client Tariff Id. |
| merchantTariffId | string | Merchant Tariff Id. |
POST Merchantorders
data = {
"address1": "76862 Calle 13",
"mastercardPayFacID": "11111",
"visaPayFacID": "22222",
"agentEmail": "agent@email.com",
"city": "Medellin",
"clientReferences": [
{
"domain": "ClientReference-Amex",
"index": "201",
"value": "345623"
}
],
"clientTariffId": "001051",
"company": "mmis test company",
"country": "COL",
"eCommerceInd": "001",
"email": "officer@company.com",
"first_name": "Juan",
"last_name": "Valderrama",
"omnipayLanguage": "Spanish",
"phone": "573043971234",
"postingTariffId": "052",
"pricingDetails": [
{
"pricingDetailId": 8,
"pricingTypeId": 111210,
"productId": "2010578888888942",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase":"3",
"omnipayFeePercent":"5"
}
],
"pricingOptions": {
"companyId": 10222,
"transactionInfo": {
"annualVolume": 23.1429,
"averageTicket": 179.5174,
"category": "RETAIL",
"creditCardVolume": 787.0473,
"highestTicket": 988.2817,
"mcc": "4511"
}
},
"serviceIdToMerchantTariffIdList": [
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "201"
}
],
"settlementMethodId": "104",
"state": "AN",
"subgroupCountyId": "005",
"subgroupLegalForm": "LF2",
"subgroupLegalName": "mmis test legal name",
"subgroupMunicipalityId": "05001",
"zip": "00000"
}
endpoint = "/marketplace/v1/merchantorders"
r = requests.post(url + endpoint, json=data, headers=headers)
print(r)
ENDPOINT="$URL/marketplace/v1/merchantorders"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
"address1": "76862 Calle 13",
"mastercardPayFacID": "11111",
"visaPayFacID": "22222",
"agentEmail": "agent@email.com",
"city": "Medellin",
"clientReferences": [
{
"domain": "ClientReference-Amex",
"index": "201",
"value": "345623"
}
],
"clientTariffId": "001051",
"company": "mmis test company",
"country": "COL",
"eCommerceInd": "001",
"email": "officer@company.com",
"first_name": "Juan",
"last_name": "Valderrama",
"omnipayLanguage": "Spanish",
"phone": "573043971234",
"postingTariffId": "052",
"pricingDetails": [
{
"pricingDetailId": 8,
"pricingTypeId": 111210,
"productId": "2010578888888942",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase":"3",
"omnipayFeePercent":"5"
}
],
"pricingOptions": {
"companyId": 10222,
"transactionInfo": {
"annualVolume": 23.1429,
"averageTicket": 179.5174,
"category": "RETAIL",
"creditCardVolume": 787.0473,
"highestTicket": 988.2817,
"mcc": "4511"
}
},
"serviceIdToMerchantTariffIdList": [
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "201"
}
],
"settlementMethodId": "104",
"state": "AN",
"subgroupCountyId": "005",
"subgroupLegalForm": "LF2",
"subgroupLegalName": "mmis test legal name",
"subgroupMunicipalityId": "05001",
"zip": "00000"
}' $ENDPOINT
var options = {
"address1": "76862 Calle 13",
"mastercardPayFacID": "11111",
"visaPayFacID": "22222",
"agentEmail": "agent@email.com",
"city": "Medellin",
"clientReferences": [
{
"domain": "ClientReference-Amex",
"index": "201",
"value": "345623"
}
],
"clientTariffId": "001051",
"company": "mmis test company",
"country": "COL",
"eCommerceInd": "001",
"email": "officer@company.com",
"first_name": "Juan",
"last_name": "Valderrama",
"omnipayLanguage": "Spanish",
"phone": "573043971234",
"postingTariffId": "052",
"pricingDetails": [
{
"pricingDetailId": 8,
"pricingTypeId": 111210,
"productId": "2010578888888942",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase":"3",
"omnipayFeePercent":"5"
}
],
"pricingOptions": {
"companyId": 10222,
"transactionInfo": {
"annualVolume": 23.1429,
"averageTicket": 179.5174,
"category": "RETAIL",
"creditCardVolume": 787.0473,
"highestTicket": 988.2817,
"mcc": "4511"
}
},
"serviceIdToMerchantTariffIdList": [
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "201"
}
],
"settlementMethodId": "104",
"state": "AN",
"subgroupCountyId": "005",
"subgroupLegalForm": "LF2",
"subgroupLegalName": "mmis test legal name",
"subgroupMunicipalityId": "05001",
"zip": "00000"
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
try {
String jsonString = "{\n" +
"\"address1\": \"76862 Calle 13\",\n" +
"\"mastercardPayFacID\": \"11111\",\n" +
"\"visaPayFacID\": \"22222\",\n" +
"\"agentEmail\": \"agent@email.com\",\n" +
"\"city\": \"Medellin\",\n" +
"\"clientReferences\": [\n" +
" {\n" +
" \"domain\": \"ClientReference-Amex\",\n" +
" \"index\": \"201\",\n" +
" \"value\": \"345623\"\n" +
" }\n" +
"],\n" +
"\"clientTariffId\": \"001051\",\n" +
"\"company\": \"mmis test company\",\n" +
"\"country\": \"COL\",\n" +
"\"eCommerceInd\": \"001\",\n" +
"\"email\": \"officer@company.com\",\n" +
"\"first_name\": \"Juan\",\n" +
"\"last_name\": \"Valderrama\",\n" +
"\"omnipayLanguage\": \"Spanish\",\n" +
"\"phone\": \"573043971234\",\n" +
"\"postingTariffId\": \"052\",\n" +
"\"pricingDetails\": [\n" +
" {\n" +
" \"pricingDetailId\": 8,\n" +
" \"pricingTypeId\": 111210,\n" +
" \"productId\": \"2010578888888942\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\":\"3\",\n" +
" \"omnipayFeePercent\":\"5\"\n" +
" }\n" +
"],\n" +
"\"pricingOptions\": {\n" +
" \"companyId\": 10222,\n" +
" \"transactionInfo\": {\n" +
" \"annualVolume\": 23.1429,\n" +
" \"averageTicket\": 179.5174,\n" +
" \"category\": \"RETAIL\",\n" +
" \"creditCardVolume\": 787.0473,\n" +
" \"highestTicket\": 988.2817,\n" +
" \"mcc\": \"4511\"\n" +
" }\n" +
"},\n" +
"\"serviceIdToMerchantTariffIdList\": [\n" +
" {\n" +
" \"assignedServices\": \"001\",\n" +
" \"merchantTariffId\": \"001011\",\n" +
" \"serviceId\": \"201\"\n " +
" }\n" +
"],\n" +
"\"settlementMethodId\": \"104\",\n" +
"\"state\": \"AN\",\n" +
"\"subgroupCountyId\": \"005\",\n" +
"\"subgroupLegalForm\": \"LF2\",\n" +
"\"subgroupLegalName\": \"mmis test legal name\",\n" +
"\"subgroupMunicipalityId\": \"05001\",\n" +
"\"zip\": \"00000\"\n" +
"}";
StringEntity payload = new StringEntity(jsonString);
HttpResponse response = doPost("/marketplace/v1/merchantorders", payload);
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
JSONArray json = new JSONArray(response_string);
System.out.println("json:" + json.toString());
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$data = array (
'address1' => '76862 Calle 13',
'mastercardPayFacID' => '11111',
'visaPayFacID' => '22222',
'agentEmail' => 'agent@email.com',
'city' => 'Medellin',
'clientReferences' =>
array (
0 =>
array (
'domain' => 'ClientReference-Amex',
'index' => '201',
'value' => '345623',
),
),
'clientTariffId' => '001051',
'company' => 'mmis test company',
'country' => 'COL',
'eCommerceInd' => '001',
'email' => 'officer@company.com',
'first_name' => 'Juan',
'last_name' => 'Valderrama',
'omnipayLanguage' => 'Spanish',
'phone' => '573043971234',
'postingTariffId' => '052',
'pricingDetails' =>
array (
0 =>
array (
'pricingDetailId' => 8,
'pricingTypeId' => 111210,
'productId' => '2010578888888942',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5',
),
),
'pricingOptions' =>
array (
'companyId' => 10222,
'transactionInfo' =>
array (
'annualVolume' => 23.1429,
'averageTicket' => 179.5174,
'category' => 'RETAIL',
'creditCardVolume' => 787.0473,
'highestTicket' => 988.2817,
'mcc' => '4511',
),
),
'serviceIdToMerchantTariffIdList' =>
array (
0 =>
array (
'assignedServices' => '001',
'merchantTariffId' => '001011',
'serviceId' => '201',
),
),
'settlementMethodId' => '104',
'state' => 'AN',
'subgroupCountyId' => '005',
'subgroupLegalForm' => 'LF2',
'subgroupLegalName' => 'mmis test legal name',
'subgroupMunicipalityId' => '05001',
'zip' => '00000',
)
$data_json = json_encode($data);
$headers = array(
'date: ' . $date,
'Authorization: ' . $hmacAuth,
'Content-Type: application/json',
'Content-Length: ' . strlen($data_json)
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/marketplace/v1/merchantorders");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_json);
$res = curl_exec($ch);
echo($res);
?>
The above command returns JSON structured like this:
{
"orderId": "OpppE"
}
This endpoint retrieves a unique orderId once the shopping cart checkout process is completed. This numeric identifier is then used in the merchant boarding process as input to reference the order.
It is used for purposes of collecting information about shipping the product(s) to the merchant after the merchant boarding process is completed and approved.
Request
POST /marketplace/v1/merchantorders
The endpoint takes a JSON object as input, which contains following information.
| Parameter | Required | Data Type | Short Description |
|---|---|---|---|
| parentMerchantId | string | Omnipay Subgroup MID | |
| company | ✔ | string | Company name (DBA name). |
| subgroupLegalName | ✔ | string | Legal name for sub group level. |
| subgroupLegalForm | ✔ | string | Legal form for subgroup level. |
| subgroupRegionalTax | ✔ | string | Subgroup Regional Tax. |
| subgroupWithholdTaxTariffId | ✔ | string | Subgroup Withhold Tax Tariff Id. |
| subgroupWithholdVATTariffId | ✔ | string | Subgroup Withhold VAT Tariff Id. |
| omnipayLanguage | ✔ | string | Language. |
| subgroupMunicipalityId | ✔ | string | Subgroup Municipality Id. |
| subgroupCountyId | ✔ | string | Subgroup County Id. |
| first_name | ✔ | string | Merchant first name. |
| last_name | ✔ | string | Merchant last name. |
| ✔ | string | Merchant email address. | |
| phone | ✔ | string | Merchant phone number. |
| address1 | ✔ | string | Merchant address. |
| city | ✔ | string | City. |
| state | ✔ | string | State. |
| zip | ✔ | string | ZIP code. |
| country | ✔ | string | Country abbreviation. |
| recordType | string | SalesForce object. Possible Values: "Lead". | |
| agentEmail | ✔ | string | Agent email. |
| typeOfBusiness | string | ||
| eCommerceInd | ✔ | string | E-commerce indicator. |
| settlementMethodId | ✔ | string | Settlement method id coming from Omnipay config file. |
| postingTariffId | ✔ | string | A posting tariff is a further way of distinguishing controls between merchants within the same service contract, allowing separate account fees and posting instructions. Posting tariff id coming from Omnipay config file. |
| clientTariffId | ✔ | string | Client tariff id coming from Omnipay config file. |
| mastercardPayFacID | string | Mastercard Payment Facilitator ID. | |
| visaPayFacID | string | Visa Payment Facilitator ID. | |
| vatRegNo | string | NIT of the subgroup. | |
| uniqRefId | string | Legacy “OurReference” Field. | |
| salesAgentCode | string | Merchant tariff id coming from Omnipay config file. | |
| businessOwner | string | ||
| serviceIdToMerchantTariffIdList | array | List of cart serviceIdToMerchantTariffIdList. Contains serviceId, merchantTariffId and assignedServices. | |
| serviceId | ✔ | string | Service id coming from Omnipay config file. |
| merchantTariffId | ✔ | string | Merchant tariff id coming from Omnipay config file. |
| assignedServices | ✔ | string | Defines the card brands allowed to be processed. |
| clientReferences | array | List of cart clientReferences. Contains domain, index and value. | |
| domain | ✔ | string | |
| index | ✔ | string | |
| value | ✔ | string | |
| propertyFieldList | array | List of cart propertyFieldList. Contains propertyfield and propertyValue. | |
| propertyfield | string | Property field. | |
| propertyValue | string | Property value. | |
| pricingDetails | array | Array of object each containing the detailed pricing information of a product (pricingDetailId, pricingTypeId, productId, etc.) in the order. | |
| pricingDetailId | ✔ | long | Pricing detail ID. |
| pricingTypeId | ✔ | long | Pricing type ID. |
| productId | ✔ | string | Product ID. |
| description | string | Short description of the product. | |
| feeMinAbsolute | double | Minimum Absolute Fee. | |
| feeMin | double | Minimum Fee. | |
| feeDefault | double | Default Fee. | |
| feeMax | double | Maximum Fee. | |
| feeMaxAbsolute | double | Maximum Absolute Fee. | |
| minAmountAbsolute | double | Minimum Absolute Fee. | |
| minAmt | double | Minimum Amount. | |
| defaultAmt | double | Default Amount. | |
| maxAmt | double | Maximum Amount. | |
| maxAmountAbsolute | double | Maximum Absolute Amount. | |
| quantity | integer | Quantity. | |
| rateMinAbsolute | double | Rate Minimum Absolute. | |
| rateMin | double | Rate Minimum. | |
| rateDefault | double | Rate Default. | |
| rateMax | double | Rate Maximum. | |
| rateMaxAbsolute | double | Rate Maximum Absolute. | |
| productName | string | Product name. | |
| productType | ✔ | string | Product Type. |
| omnipayFeeBase | ✔ | string | Fee base to be sent to omnipay. |
| omnipayFeePercent | ✔ | string | |
| isOverride | boolean | Flag isOverride. | |
| override | boolean | Flag override. | |
| showoncart | boolean | Flag to show on cart ‘true or false’ | |
| purchaseType | string | ||
| paymentType | string | ||
| paymentTerm | string | ||
| occurrence | object | Contains type. | |
| type | string | Type of occurrence. | |
| category | string | ||
| cardNotPresentDiscountRates | array | ||
| pricingOptions | ✔ | object | Object containing companyId and transactionInfo. |
| companyId | ✔ | long | Company Id. |
| transactionInfo | ✔ | object | Object containing mccTypes, mcc, annualVolume, creditCardVolume, averageTicket, amexVolume, amexMemberId, highestTicket and category. |
| mccTypes | string | MCC Type. | |
| mcc | ✔ | string | MCC. |
| annualVolume | ✔ | double | Annual volume. |
| creditCardVolume | ✔ | double | Annual card volume. |
| averageTicket | ✔ | double | Average ticket. |
| amexVolume | double | Amex volume. | |
| amexMemberId | long | Amex member Id. | |
| highestTicket | ✔ | double | Highest ticket. |
| category | string | Category. | |
| shippingAddress | array | Array of objects containing company_name, firstname, lastname, etc. | |
| company_name | string | DBA name. | |
| firstname | string | First name. | |
| lastname | string | Last name. | |
| address1 | string | Address 1. | |
| address2 | string | Address 2. | |
| city | string | City. | |
| zip | string | Postal code. | |
| state | string | State. | |
string | Email. | ||
| email2 | string | Alternate email. | |
| phone | string | Phone number. | |
| productstoShip | array | Array of objects containing prodId and term. | |
| prodId | string | Product Id to ship. | |
| term | string | Product term. | |
| cardNotPresent | integer | ||
| cartDetails | object | Object containing data, which is an array of objects. | |
| data | array | Array of objects containing company_name, firstname, lastname, etc. | |
| id | string | Product ID. | |
| name | string | Product name. | |
| price | double | Price for a product. | |
| term | string | Term. | |
| qty | integer | Quantity. | |
| productType | string | Product type. | |
| category | string | Category. | |
| amount | double | Product amount. | |
| shipping_amount | double | Shipping amount. | |
| tax | double | Tax. | |
| taxPercent | double | Tax percent. | |
| total | double | Total amount. | |
| status | integer | ||
| purchaseEnabled | boolean | ||
| total_qty | integer | ||
| shipping_option_id | integer | Shipping option. | |
| numberofLocations | integer | Number of locations. |
Response
The endpoint returns an object containing one string which represents the orderId.
| Parameter | Data Type | Description |
|---|---|---|
| orderId | string | Order Id. The numeric identifier to be used in the merchant boarding process as input to reference the order. |
POST Merchantorders/Businessinformation
data = {
"ownerInformation": [
{
"sequenceNo": 1,
"contactType": "OWNER",
"firstName": "Test",
"lastName": "Last",
"gender": "M",
"ssn": "989898988",
"nationalIdType": "NIT",
"nationalIdValue": "2",
"passportNumber": "KB00767234",
"passportCountryCode": "COL",
"typeOfBusiness": "SERVICES",
"dateofBirth": "1990-12-26",
"title": "Mr",
"percentOwned": 100,
"contactInformation": {
"contactType": "OWNER",
"address1": "1 av",
"city": "Medellin",
"state": "AN",
"postalCode": "94089",
"country": "COL",
"phone": "9164741861",
"email": "test@gmail.com"
}
}
],
"merchantInformation": [
{
"sequenceNo": 3,
"legalName": "mmis test bnc1",
"taxId": "989898988",
"yearsInBusiness": "2016-03-01",
"taxFilingName": "mmis test BCOr",
"foreignEntityOption": "A",
"tinRequestedGuid": "",
"tinType": "1",
"vatRegNo": "1234567890",
"uniqRefId": "871637123",
"eCommerceInd": "002",
"legalFormForDiligence": "LF1",
"url": "www.test.com",
"withholdTaxTariffId": "001",
"withholdVATTariffId": "005",
"countyId": "005",
"municipalityId": "05001",
"regionalTax": "000",
"propertyFieldList": [
{
"propertyfield": "008",
"propertyValue": "71763852"
}
],
"serviceIdToMerchantTariffIdList": [
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "201"
},
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "203"
}
],
"pricingDetails": [
{
"productId": "2010008000000022",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5.5",
"feeMin": 2,
"feeMax": 100
},
{
"productId": "2010008000000023",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "7.65",
"feeMin": 3,
"feeMax": 10
},
{
"productId": "2010008000000024",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "6",
"omnipayFeePercent": "9.666",
"feeMin": 5,
"feeMax": 99
},
{
"productId": "2010008000000025",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "10.3432",
"feeMin": 2,
"feeMax": 98
},
{
"productId": "2010008000000026",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5.6",
"feeMin": 2,
"feeMax": 97
},
{
"productId": "2010008000000027",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 96
},
{
"productId": "2010008000000028",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 95
},
{
"productId": "2010008000000029",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 1,
"feeMax": 94
},
{
"productId": "2010008000000030",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 93
},
{
"productId": "2010008000000031",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 92
},
{
"productId": "2010008000000032",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 91
},
{
"productId": "2010008000000033",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 90
},
{
"productId": "2030008000000034",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "6"
},
{
"productId": "2030008000000035",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "6",
"omnipayFeePercent": "7",
"feeMin": 2,
"feeMax": 89
},
{
"productId": "2030008000000036",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "7",
"omnipayFeePercent": "8",
"feeMin": 2,
"feeMax": 88
},
{
"productId": "2030008000000037",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "9",
"omnipayFeePercent": "8",
"feeMin": 2,
"feeMax": 87
},
{
"productId": "2030008000000038",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "7",
"omnipayFeePercent": "6",
"feeMin": 2,
"feeMax": 86
},
{
"productId": "2030008000000039",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "1",
"feeMin": 2,
"feeMax": 85
}
],
"contactInformation": [
{
"contactType": "STANDARD",
"address1": "Cl. 25 #51-33",
"city": "Medellin",
"state": "AN",
"postalCode": "00000",
"country": "COL",
"phone": "3048826636",
"email": "standardCorpContact1@postobon.com",
"contactName": "Juan Jose"
},
{
"contactType": "DISPUTE",
"address1": "Cl. 25 #52-34",
"city": "Medellin",
"state": "AN",
"postalCode": "00000",
"country": "COL",
"phone": "3048826637",
"email": "disputedCorpContact1@postobon.com",
"contactName": "Juan Valderrama"
}
]
}
]
}
endpoint = "/marketplace/v1/merchantorders/12345/businessinformation"
r = requests.post(url + endpoint, json=data, headers=headers)
print(r)
ENDPOINT="$URL/marketplace/v1/merchantorders/12345/businessinformation"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
"ownerInformation": [
{
"sequenceNo": 1,
"contactType": "OWNER",
"firstName": "Test",
"lastName": "Last",
"gender": "M",
"ssn": "989898988",
"nationalIdType": "NIT",
"nationalIdValue": "2",
"passportNumber": "KB00767234",
"passportCountryCode": "COL",
"typeOfBusiness": "SERVICES",
"dateofBirth": "1990-12-26",
"title": "Mr",
"percentOwned": 100,
"contactInformation": {
"contactType": "OWNER",
"address1": "1 av",
"city": "Medellin",
"state": "AN",
"postalCode": "94089",
"country": "COL",
"phone": "9164741861",
"email": "test@gmail.com"
}
}
],
"merchantInformation": [
{
"sequenceNo": 3,
"legalName": "mmis test bnc1",
"taxId": "989898988",
"yearsInBusiness": "2016-03-01",
"taxFilingName": "mmis test BCOr",
"foreignEntityOption": "A",
"tinRequestedGuid": "",
"tinType": "1",
"vatRegNo": "1234567890",
"uniqRefId": "871637123",
"eCommerceInd": "002",
"legalFormForDiligence": "LF1",
"url": "www.test.com",
"withholdTaxTariffId": "001",
"withholdVATTariffId": "005",
"countyId": "005",
"municipalityId": "05001",
"regionalTax": "000",
"propertyFieldList": [
{
"propertyfield": "008",
"propertyValue": "71763852"
}
],
"serviceIdToMerchantTariffIdList": [
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "201"
},
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "203"
}
],
"pricingDetails": [
{
"productId": "2010008000000022",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5.5",
"feeMin": 2,
"feeMax": 100
},
{
"productId": "2010008000000023",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "7.65",
"feeMin": 3,
"feeMax": 10
},
{
"productId": "2010008000000024",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "6",
"omnipayFeePercent": "9.666",
"feeMin": 5,
"feeMax": 99
},
{
"productId": "2010008000000025",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "10.3432",
"feeMin": 2,
"feeMax": 98
},
{
"productId": "2010008000000026",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5.6",
"feeMin": 2,
"feeMax": 97
},
{
"productId": "2010008000000027",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 96
},
{
"productId": "2010008000000028",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 95
},
{
"productId": "2010008000000029",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 1,
"feeMax": 94
},
{
"productId": "2010008000000030",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 93
},
{
"productId": "2010008000000031",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 92
},
{
"productId": "2010008000000032",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 91
},
{
"productId": "2010008000000033",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 90
},
{
"productId": "2030008000000034",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "6"
},
{
"productId": "2030008000000035",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "6",
"omnipayFeePercent": "7",
"feeMin": 2,
"feeMax": 89
},
{
"productId": "2030008000000036",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "7",
"omnipayFeePercent": "8",
"feeMin": 2,
"feeMax": 88
},
{
"productId": "2030008000000037",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "9",
"omnipayFeePercent": "8",
"feeMin": 2,
"feeMax": 87
},
{
"productId": "2030008000000038",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "7",
"omnipayFeePercent": "6",
"feeMin": 2,
"feeMax": 86
},
{
"productId": "2030008000000039",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "1",
"feeMin": 2,
"feeMax": 85
}
],
"contactInformation": [
{
"contactType": "STANDARD",
"address1": "Cl. 25 #51-33",
"city": "Medellin",
"state": "AN",
"postalCode": "00000",
"country": "COL",
"phone": "3048826636",
"email": "standardCorpContact1@postobon.com",
"contactName": "Juan Jose"
},
{
"contactType": "DISPUTE",
"address1": "Cl. 25 #52-34",
"city": "Medellin",
"state": "AN",
"postalCode": "00000",
"country": "COL",
"phone": "3048826637",
"email": "disputedCorpContact1@postobon.com",
"contactName": "Juan Valderrama"
}
]
}
]
}' $ENDPOINT
var options = {
method: 'POST',
url: url + '/marketplace/v1/merchantorders/12345/businessinformation',
headers: getAuthenticationHeaders(),
body: {
"ownerInformation": [
{
"sequenceNo": 1,
"contactType": "OWNER",
"firstName": "Test",
"lastName": "Last",
"gender": "M",
"ssn": "989898988",
"nationalIdType": "NIT",
"nationalIdValue": "2",
"passportNumber": "KB00767234",
"passportCountryCode": "COL",
"typeOfBusiness": "SERVICES",
"dateofBirth": "1990-12-26",
"title": "Mr",
"percentOwned": 100,
"contactInformation": {
"contactType": "OWNER",
"address1": "1 av",
"city": "Medellin",
"state": "AN",
"postalCode": "94089",
"country": "COL",
"phone": "9164741861",
"email": "test@gmail.com"
}
}
],
"merchantInformation": [
{
"sequenceNo": 3,
"legalName": "mmis test bnc1",
"taxId": "989898988",
"yearsInBusiness": "2016-03-01",
"taxFilingName": "mmis test BCOr",
"foreignEntityOption": "A",
"tinRequestedGuid": "",
"tinType": "1",
"vatRegNo": "1234567890",
"uniqRefId": "871637123",
"eCommerceInd": "002",
"legalFormForDiligence": "LF1",
"url": "www.test.com",
"withholdTaxTariffId": "001",
"withholdVATTariffId": "005",
"countyId": "005",
"municipalityId": "05001",
"regionalTax": "000",
"propertyFieldList": [
{
"propertyfield": "008",
"propertyValue": "71763852"
}
],
"serviceIdToMerchantTariffIdList": [
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "201"
},
{
"assignedServices": "001",
"merchantTariffId": "001011",
"serviceId": "203"
}
],
"pricingDetails": [
{
"productId": "2010008000000022",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5.5",
"feeMin": 2,
"feeMax": 100
},
{
"productId": "2010008000000023",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "7.65",
"feeMin": 3,
"feeMax": 10
},
{
"productId": "2010008000000024",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "6",
"omnipayFeePercent": "9.666",
"feeMin": 5,
"feeMax": 99
},
{
"productId": "2010008000000025",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "10.3432",
"feeMin": 2,
"feeMax": 98
},
{
"productId": "2010008000000026",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5.6",
"feeMin": 2,
"feeMax": 97
},
{
"productId": "2010008000000027",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 96
},
{
"productId": "2010008000000028",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 95
},
{
"productId": "2010008000000029",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 1,
"feeMax": 94
},
{
"productId": "2010008000000030",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 93
},
{
"productId": "2010008000000031",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 92
},
{
"productId": "2010008000000032",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 91
},
{
"productId": "2010008000000033",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "3",
"omnipayFeePercent": "5",
"feeMin": 2,
"feeMax": 90
},
{
"productId": "2030008000000034",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "6"
},
{
"productId": "2030008000000035",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "6",
"omnipayFeePercent": "7",
"feeMin": 2,
"feeMax": 89
},
{
"productId": "2030008000000036",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "7",
"omnipayFeePercent": "8",
"feeMin": 2,
"feeMax": 88
},
{
"productId": "2030008000000037",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "9",
"omnipayFeePercent": "8",
"feeMin": 2,
"feeMax": 87
},
{
"productId": "2030008000000038",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "7",
"omnipayFeePercent": "6",
"feeMin": 2,
"feeMax": 86
},
{
"productId": "2030008000000039",
"productType": "MERCHANT_TARIFF",
"omnipayFeeBase": "5",
"omnipayFeePercent": "1",
"feeMin": 2,
"feeMax": 85
}
],
"contactInformation": [
{
"contactType": "STANDARD",
"address1": "Cl. 25 #51-33",
"city": "Medellin",
"state": "AN",
"postalCode": "00000",
"country": "COL",
"phone": "3048826636",
"email": "standardCorpContact1@postobon.com",
"contactName": "Juan Jose"
},
{
"contactType": "DISPUTE",
"address1": "Cl. 25 #52-34",
"city": "Medellin",
"state": "AN",
"postalCode": "00000",
"country": "COL",
"phone": "3048826637",
"email": "disputedCorpContact1@postobon.com",
"contactName": "Juan Valderrama"
}
]
}
]
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
try {
String jsonString = "{\n" +
"\"ownerInformation\": [\n" +
" {\n" +
" \"sequenceNo\": 1,\n" +
" \"contactType\": \"OWNER\",\n" +
" \"firstName\": \"Test\",\n" +
" \"lastName\": \"Last\",\n" +
" \"gender\": \"M\",\n" +
" \"ssn\": \"989898988\",\n" +
" \"nationalIdType\": \"NIT\",\n" +
" \"nationalIdValue\": \"2\",\n" +
" \"passportNumber\": \"KB00767234\",\n" +
" \"passportCountryCode\": \"COL\",\n" +
" \"typeOfBusiness\": \"SERVICES\",\n" +
" \"dateofBirth\": \"1990-12-26\",\n" +
" \"title\": \"Mr\",\n" +
" \"percentOwned\": 100,\n" +
" \"contactInformation\": {\n" +
" \"contactType\": \"OWNER\",\n" +
" \"address1\": \"1 av\",\n" +
" \"city\": \"Medellin\",\n" +
" \"state\": \"AN\",\n" +
" \"postalCode\": \"94089\",\n" +
" \"country\": \"COL\",\n" +
" \"phone\": \"9164741861\",\n" +
" \"email\": \"test@gmail.com\"\n" +
" }\n" +
" }\n" +
"],\n" +
"\"merchantInformation\": [\n" +
" {\n" +
" \"sequenceNo\": 3,\n" +
" \"legalName\": \"mmis test bnc1\",\n" +
" \"taxId\": \"989898988\",\n" +
" \"yearsInBusiness\": \"2016-03-01\",\n" +
" \"taxFilingName\": \"mmis test BCOr\",\n" +
" \"foreignEntityOption\": \"A\",\n" +
" \"tinRequestedGuid\": \"\",\n" +
" \"tinType\": \"1\",\n" +
" \"vatRegNo\": \"1234567890\",\n" +
" \"uniqRefId\": \"871637123\",\n" +
" \"eCommerceInd\": \"002\",\n" +
" \"legalFormForDiligence\": \"LF1\",\n" +
" \"url\": \"www.test.com\",\n" +
" \"withholdTaxTariffId\": \"001\",\n" +
" \"withholdVATTariffId\": \"005\",\n" +
" \"countyId\": \"005\",\n" +
" \"municipalityId\": \"05001\",\n" +
" \"regionalTax\": \"000\",\n" +
" \"propertyFieldList\": [\n" +
" {\n" +
" \"propertyfield\": \"008\",\n" +
" \"propertyValue\": \"71763852\"\n" +
" }\n" +
" ],\n" +
" \"serviceIdToMerchantTariffIdList\": [\n" +
" {\n" +
" \"assignedServices\": \"001\",\n" +
" \"merchantTariffId\": \"001011\",\n" +
" \"serviceId\": \"201\"\n" +
" },\n" +
" {\n" +
" \"assignedServices\": \"001\",\n" +
" \"merchantTariffId\": \"001011\",\n" +
" \"serviceId\": \"203\"\n" +
" }\n" +
" ],\n" +
" \"pricingDetails\": [\n" +
" {\n" +
" \"productId\": \"2010008000000022\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5.5\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 100\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000023\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"5\",\n" +
" \"omnipayFeePercent\": \"7.65\",\n" +
" \"feeMin\": 3,\n" +
" \"feeMax\": 10\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000024\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"6\",\n" +
" \"omnipayFeePercent\": \"9.666\",\n" +
" \"feeMin\": 5,\n" +
" \"feeMax\": 99\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000025\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"10.3432\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 98\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000026\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5.6\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 97\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000027\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 96\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000028\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 95\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000029\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5\",\n" +
" \"feeMin\": 1,\n" +
" \"feeMax\": 94\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000030\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 93\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000031\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 92\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000032\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 91\n" +
" },\n" +
" {\n" +
" \"productId\": \"2010008000000033\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"3\",\n" +
" \"omnipayFeePercent\": \"5\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 90\n" +
" },\n" +
" {\n" +
" \"productId\": \"2030008000000034\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"5\",\n" +
" \"omnipayFeePercent\": \"6\"\n" +
" },\n" +
" {\n" +
" \"productId\": \"2030008000000035\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"6\",\n" +
" \"omnipayFeePercent\": \"7\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 89\n" +
" },\n" +
" {\n" +
" \"productId\": \"2030008000000036\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"7\",\n" +
" \"omnipayFeePercent\": \"8\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 88\n" +
" },\n" +
" {\n" +
" \"productId\": \"2030008000000037\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"9\",\n" +
" \"omnipayFeePercent\": \"8\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 87\n" +
" },\n" +
" {\n" +
" \"productId\": \"2030008000000038\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"7\",\n" +
" \"omnipayFeePercent\": \"6\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 86\n" +
" },\n" +
" {\n" +
" \"productId\": \"2030008000000039\",\n" +
" \"productType\": \"MERCHANT_TARIFF\",\n" +
" \"omnipayFeeBase\": \"5\",\n" +
" \"omnipayFeePercent\": \"1\",\n" +
" \"feeMin\": 2,\n" +
" \"feeMax\": 85\n" +
" }\n" +
" ],\n" +
" \"contactInformation\": [\n" +
" {\n" +
" \"contactType\": \"STANDARD\",\n" +
" \"address1\": \"Cl. 25 #51-33\",\n" +
" \"city\": \"Medellin\",\n" +
" \"state\": \"AN\",\n" +
" \"postalCode\": \"00000\",\n" +
" \"country\": \"COL\",\n" +
" \"phone\": \"3048826636\",\n" +
" \"email\": \"standardCorpContact1@postobon.com\",\n" +
" \"contactName\": \"Juan Jose\"\n" +
" },\n" +
" {\n" +
" \"contactType\": \"DISPUTE\",\n" +
" \"address1\": \"Cl. 25 #52-34\",\n" +
" \"city\": \"Medellin\",\n" +
" \"state\": \"AN\",\n" +
" \"postalCode\": \"00000\",\n" +
" \"country\": \"COL\",\n" +
" \"phone\": \"3048826637\",\n" +
" \"email\": \"disputedCorpContact1@postobon.com\",\n" +
" \"contactName\": \"Juan Valderrama\"\n" +
" }\n" +
" ]\n" +
" }\n" +
"]\n" +
"}";
StringEntity payload = new StringEntity(jsonString);
HttpResponse response = doPost("/marketplace/v1/merchantorders/12345/businessinformation", payload);
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
JSONArray json = new JSONArray(response_string);
System.out.println("json:" + json.toString());
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$data = array (
'ownerInformation' =>
array (
0 =>
array (
'sequenceNo' => 1,
'contactType' => 'OWNER',
'firstName' => 'Test',
'lastName' => 'Last',
'gender' => 'M',
'ssn' => '989898988',
'nationalIdType' => 'NIT',
'nationalIdValue' => '2',
'passportNumber' => 'KB00767234',
'passportCountryCode' => 'COL',
'typeOfBusiness' => 'SERVICES',
'dateofBirth' => '1990-12-26',
'title' => 'Mr',
'percentOwned' => 100,
'contactInformation' =>
array (
'contactType' => 'OWNER',
'address1' => '1 av',
'city' => 'Medellin',
'state' => 'AN',
'postalCode' => '94089',
'country' => 'COL',
'phone' => '9164741861',
'email' => 'test@gmail.com',
),
),
),
'merchantInformation' =>
array (
0 =>
array (
'sequenceNo' => 3,
'legalName' => 'mmis test bnc1',
'taxId' => '989898988',
'yearsInBusiness' => '2016-03-01',
'taxFilingName' => 'mmis test BCOr',
'foreignEntityOption' => 'A',
'tinRequestedGuid' => '',
'tinType' => '1',
'vatRegNo' => '1234567890',
'uniqRefId' => '871637123',
'eCommerceInd' => '002',
'legalFormForDiligence' => 'LF1',
'url' => 'www.test.com',
'withholdTaxTariffId' => '001',
'withholdVATTariffId' => '005',
'countyId' => '005',
'municipalityId' => '05001',
'regionalTax' => '000',
'propertyFieldList' =>
array (
0 =>
array (
'propertyfield' => '008',
'propertyValue' => '71763852',
),
),
'serviceIdToMerchantTariffIdList' =>
array (
0 =>
array (
'assignedServices' => '001',
'merchantTariffId' => '001011',
'serviceId' => '201',
),
1 =>
array (
'assignedServices' => '001',
'merchantTariffId' => '001011',
'serviceId' => '203',
),
),
'pricingDetails' =>
array (
0 =>
array (
'productId' => '2010008000000022',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5.5',
'feeMin' => 2,
'feeMax' => 100,
),
1 =>
array (
'productId' => '2010008000000023',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '5',
'omnipayFeePercent' => '7.65',
'feeMin' => 3,
'feeMax' => 10,
),
2 =>
array (
'productId' => '2010008000000024',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '6',
'omnipayFeePercent' => '9.666',
'feeMin' => 5,
'feeMax' => 99,
),
3 =>
array (
'productId' => '2010008000000025',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '10.3432',
'feeMin' => 2,
'feeMax' => 98,
),
4 =>
array (
'productId' => '2010008000000026',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5.6',
'feeMin' => 2,
'feeMax' => 97,
),
5 =>
array (
'productId' => '2010008000000027',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5',
'feeMin' => 2,
'feeMax' => 96,
),
6 =>
array (
'productId' => '2010008000000028',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5',
'feeMin' => 2,
'feeMax' => 95,
),
7 =>
array (
'productId' => '2010008000000029',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5',
'feeMin' => 1,
'feeMax' => 94,
),
8 =>
array (
'productId' => '2010008000000030',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5',
'feeMin' => 2,
'feeMax' => 93,
),
9 =>
array (
'productId' => '2010008000000031',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5',
'feeMin' => 2,
'feeMax' => 92,
),
10 =>
array (
'productId' => '2010008000000032',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5',
'feeMin' => 2,
'feeMax' => 91,
),
11 =>
array (
'productId' => '2010008000000033',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '3',
'omnipayFeePercent' => '5',
'feeMin' => 2,
'feeMax' => 90,
),
12 =>
array (
'productId' => '2030008000000034',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '5',
'omnipayFeePercent' => '6',
),
13 =>
array (
'productId' => '2030008000000035',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '6',
'omnipayFeePercent' => '7',
'feeMin' => 2,
'feeMax' => 89,
),
14 =>
array (
'productId' => '2030008000000036',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '7',
'omnipayFeePercent' => '8',
'feeMin' => 2,
'feeMax' => 88,
),
15 =>
array (
'productId' => '2030008000000037',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '9',
'omnipayFeePercent' => '8',
'feeMin' => 2,
'feeMax' => 87,
),
16 =>
array (
'productId' => '2030008000000038',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '7',
'omnipayFeePercent' => '6',
'feeMin' => 2,
'feeMax' => 86,
),
17 =>
array (
'productId' => '2030008000000039',
'productType' => 'MERCHANT_TARIFF',
'omnipayFeeBase' => '5',
'omnipayFeePercent' => '1',
'feeMin' => 2,
'feeMax' => 85,
),
),
'contactInformation' =>
array (
0 =>
array (
'contactType' => 'STANDARD',
'address1' => 'Cl. 25 #51-33',
'city' => 'Medellin',
'state' => 'AN',
'postalCode' => '00000',
'country' => 'COL',
'phone' => '3048826636',
'email' => 'standardCorpContact1@postobon.com',
'contactName' => 'Juan Jose',
),
1 =>
array (
'contactType' => 'DISPUTE',
'address1' => 'Cl. 25 #52-34',
'city' => 'Medellin',
'state' => 'AN',
'postalCode' => '00000',
'country' => 'COL',
'phone' => '3048826637',
'email' => 'disputedCorpContact1@postobon.com',
'contactName' => 'Juan Valderrama',
),
),
),
),
)
$data_json = json_encode($data);
$headers = array(
'date: ' . $date,
'Authorization: ' . $hmacAuth,
'Content-Type: application/json',
'Content-Length: ' . strlen($data_json)
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/marketplace/v1/merchantorders/12345/businessinformation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_json);
$res = curl_exec($ch);
echo($res);
?>
The above command returns JSON structured like this:
{
"orderId": "OpppE"
}
This endpoint collects merchant and owner information for merchant boarding purposes.
Request
POST /marketplace/v1/merchantorders/{orderId}/businessinformation
In the request URL, use the orderId as it was returned in the response of the POST Merchantorders API.
The endpoint takes a JSON object as input, which contains following information.
| Parameter | Required | Data Type | Short Description |
|---|---|---|---|
| ownerInformation | ✔ | array | Array of (minimum one) objects, each containing the information of the owner(s) of the business. |
| sequenceNo | ✔ | integer | Index of the object representing the owner. |
| contactType | ✔ | string | Type of contact. |
| firstName | ✔ | string | First name. |
| lastName | ✔ | string | Last name. |
| gender | ✔ | string | Gender. |
| ssn | ✔ | string | Social security number. |
| nationalIdType | ✔ | string | Type of ID document used. Possible values: "SSN", "License", etc. |
| nationalIdValue | ✔ | string | |
| passportNumber | ✔ | string | Passport number. |
| passportCountryCode | ✔ | string | Passport issuing country code. |
| dateofBirth | ✔ | string | Date of birth in “YYYY-MM-DD” format. |
| title | ✔ | string | Title. |
| percentOwned | ✔ | integer | Percentage owned. |
| contactInformation | ✔ | object | Object of the contact information of the owner. Contain contactType, address1, address2, address3, city, state, postalCode, country, phone, and email. |
| contactType | ✔ | string | Type of location. Possible values: "OWNER". |
| address1 | ✔ | string | Street address. |
| address2 | string | Second line of street address, if applicable. i.e. Unit, Floor, Suite, etc. | |
| address3 | string | Third line of street address. | |
| city | ✔ | string | City. |
| state | ✔ | string | State in abbreviated format. i.e. for California send "CA". |
| country | ✔ | string | ISO Standard Country Code of the country. |
| postalCode | ✔ | string | ZIP/postal code. |
| phone | ✔ | string | Phone number. |
| ✔ | string | Email address. | |
| driverLicenseNo | string | ||
| dlStateIssued | string | ||
| dlExpirationMonth | string | ||
| dlExpirationYear | string | ||
| merchantInformation | array | Array of (minimum one) objects, each containing the information about merchant. | |
| sequenceNo | ✔ | integer | Sequence Number. |
| category | string | Verticals. | |
| businessType | string | Category of business. | |
| legalName | ✔ | string | Legal business name. |
| taxId | ✔ | string | Tax identifier. |
| yearsInBusiness | ✔ | string | Business started date in “YYYY-MM-DD” format. |
| organizationType | string | Type of organization. | |
| stateOfIncorporation | string | ||
| taxFilingName | ✔ | string | Tax filing name. |
| foreignEntityOption | string | Foreign entity option. | |
| tinRequestedGuid | string | GUID for tin. | |
| tinType | string | Tin type. | |
| vatRegNo | ✔ | string | Registration number. |
| paymentMethod | string | Payment method used for omnipay. | |
| legalFormForDiligence | ✔ | string | Legal Form. |
| mccCodeDesc | string | MCC desc. | |
| tradeRegistrationNumber | string | Tied to Tid. | |
| riskLevel | string | Sales risk level. | |
| url | string | Website url. | |
| withholdTaxTariffId | ✔ | string | Tax tariff ID. |
| withholdVATTariffId | ✔ | string | Vat tariff ID. |
| countyId | ✔ | string | County ID. |
| municipalityId | ✔ | string | Municipality ID. |
| regionalTax | ✔ | string | Regional Tax. |
| paymentAdviceGeneration | string | Payment advice generation. | |
| paymentDeliveryMethod | string | Payment delivery method. | |
| propertyFieldList | array | Array of (minimum one) object(s), each of which represents a property field. Contains propertyfield, propertyValue. | |
| propertyfield | string | Property field. | |
| propertyValue | string | Property value. | |
| eCommerceInd | string | E-commerce indicator. | |
| settlementMethodId | string | Settlement method id coming from Omnipay config file. | |
| postingTariffId | string | A posting tariff is a further way of distinguishing controls between merchants within the same service contract, allowing separate account fees and posting instructions. Posting tariff id coming from Omnipay config file. | |
| clientTariffId | string | Client tariff id coming from Omnipay config file. | |
| uniqRefId | string | Legacy “OurReference” Field. | |
| serviceIdToMerchantTariffIdList | array | Array of (minimum one) object(s). Contains serviceId, merchantTariffId and assignedServices. | |
| serviceId | ✔ | string | Service id coming from Omnipay config file. |
| merchantTariffId | ✔ | string | Merchant tariff id coming from Omnipay config file. |
| assignedServices | ✔ | string | Defines the card brands allowed to be processed. |
| clientReferences | array | Array of (minimum one) object(s). Contains domain, index and value. | |
| domain | ✔ | string | |
| index | ✔ | string | |
| value | ✔ | string | |
| pricingDetails | ✔ | array | Array of object each containing the detailed pricing information of a product (pricingDetailId, pricingTypeId, productId, etc.) in the order. |
| pricingDetailId | ✔ | long | Pricing detail ID. |
| pricingTypeId | ✔ | long | Pricing type ID. |
| productId | ✔ | string | Product ID. |
| description | string | Short description of the product. | |
| feeMinAbsolute | double | Minimum Absolute Fee. | |
| feeMin | double | Minimum Fee. | |
| feeDefault | double | Default Fee. | |
| feeMax | double | Maximum Fee. | |
| feeMaxAbsolute | double | Maximum Absolute Fee. | |
| minAmountAbsolute | double | Minimum Absolute Fee. | |
| minAmt | double | Minimum Amount. | |
| defaultAmt | double | Default Amount. | |
| maxAmt | double | Maximum Amount. | |
| maxAmountAbsolute | double | Maximum Absolute Amount. | |
| quantity | integer | Quantity. | |
| rateMinAbsolute | double | Rate Minimum Absolute. | |
| rateMin | double | Rate Minimum. | |
| rateDefault | double | Rate Default. | |
| rateMax | double | Rate Maximum. | |
| rateMaxAbsolute | double | Rate Maximum Absolute. | |
| productName | string | Product name. | |
| productType | ✔ | string | Product Type. |
| omnipayFeeBase | ✔ | string | Fee base to be sent to omnipay. |
| omnipayFeePercent | ✔ | string | |
| isOverride | boolean | Flag isOverride. | |
| override | boolean | Flag override. | |
| showoncart | boolean | Flag to show on cart ‘true or false’ | |
| purchaseType | string | ||
| paymentType | string | ||
| paymentTerm | string | ||
| occurrence | object | Contains type. | |
| type | string | Type of occurrence. | |
| category | string | ||
| contactInformation | ✔ | array | Array of (minimum one) object(s), each of which represents a contact Information. contactType, address1, address2, city, state, postalCode, country, phone, contactTime, email and contactName. |
| contactType | ✔ | string | Type of contact. |
| address1 | ✔ | string | Address 1. |
| address2 | string | Address 2. | |
| city | ✔ | string | City. |
| state | ✔ | string | State. |
| postalCode | ✔ | string | ZIP/postal code. |
| country | ✔ | string | Country. |
| phone | ✔ | string | Phone. |
| contactTime | string | Contact time. | |
| ✔ | string | Email. | |
| contactName | ✔ | string | Contact name. |
| principalNationality | string | ||
| threatMetrixGuid | string | The GUID to be used to invoke the ThreatMetrix WS call internally. |
Response
The endpoint returns an object containing one string which represents the orderId.
| Parameter | Data Type | Description |
|---|---|---|
| orderId | string | The unique identifier of an order returned after successful submission. Used in following processes as input data. |
GET Merchantorders/Locations
data = {}
endpoint = "/marketplace/v1/merchantorders/{orderId}/locations"
r = requests.post(url + endpoint, json=data, headers=headers)
print(r)
ENDPOINT="$URL/marketplace/v1/merchantorders/{orderId}/locations"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
}' $ENDPOINT
var options = {
method: 'POST',
url: url + '/marketplace/v1/merchantorders/{orderId}/locations',
headers: getAuthenticationHeaders(),
body: {},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
try {
String jsonString = "{\n"
"}\n"
StringEntity payload = new StringEntity(jsonString);
HttpResponse response = doPost("/marketplace/v1/merchantorders/{orderId}/locations", payload);
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
JSONArray json = new JSONArray(response_string);
System.out.println("json:" + json.toString());
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/marketplace/v1/merchantorders/{orderId}/locations");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$res = curl_exec($ch);
echo($res);
?>
The above command returns JSON structured like this:
{
"hashOrderId": "OpppE",
"hasThirdPartyBillableProducts": false,
"locationInformation": [
{
"subCategory": "RETAIL",
"merchantId": 195052,
"dbaName": "mmis test company",
"mcc": "4511",
"annualVolume": 787.0473,
"category": "RETAIL",
"equipmentLocation": [
{
"lineItemId": 7236366,
"configurableLineItemId": 7236366,
"attributes": null
},
{
"lineItemId": 7236367,
"configurableLineItemId": 7236367,
"attributes": null
},
{
"lineItemId": 7236364,
"configurableLineItemId": 7236364,
"attributes": null
},
{
"lineItemId": 7236365,
"configurableLineItemId": 7236365,
"attributes": null
},
{
"lineItemId": 7236362,
"configurableLineItemId": 7236362,
"attributes": null
},
{
"lineItemId": 7236363,
"configurableLineItemId": 7236363,
"attributes": null
},
{
"lineItemId": 7236360,
"configurableLineItemId": 7236360,
"attributes": null
},
{
"lineItemId": 7236361,
"configurableLineItemId": 7236361,
"attributes": null
},
{
"lineItemId": 7236376,
"configurableLineItemId": 7236376,
"attributes": null
},
{
"lineItemId": 7236377,
"configurableLineItemId": 7236377,
"attributes": null
},
{
"lineItemId": 7236374,
"configurableLineItemId": 7236374,
"attributes": null
},
{
"lineItemId": 7236375,
"configurableLineItemId": 7236375,
"attributes": null
},
{
"lineItemId": 7236372,
"configurableLineItemId": 7236372,
"attributes": null
},
{
"lineItemId": 7236373,
"configurableLineItemId": 7236373,
"attributes": null
},
{
"lineItemId": 7236370,
"configurableLineItemId": 7236370,
"attributes": null
},
{
"lineItemId": 7236371,
"configurableLineItemId": 7236371,
"attributes": null
},
{
"lineItemId": 7236368,
"configurableLineItemId": 7236368,
"attributes": null
},
{
"lineItemId": 7236369,
"configurableLineItemId": 7236369,
"attributes": null
}
],
"isPrimaryLocation": true
}
]
}
The service will return the orderId, merchantIdList, southLocationInformationList, etc based on orderId as parameter.
Request
GET /marketplace/v1/merchantorders/:orderId/locations
| Parameter | Description |
|---|---|
| orderId | Unique identifier that is used to pull details |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Data Type | Description |
|---|---|---|
| hashOrderId | string | OrderId to pull details. |
| hasThirdPartyBillableProducts | boolean | Has Third Party Billable Products. |
| locationInformation | array | Has the below items like mcc, annual volume, etc. |
| subCategory | string | Sub-Category. |
| merchantId | long | Merchant Identifier. |
| mccDescription | string | MCC description. |
| mcc | string | MCC. |
| annualVolume | double | Annual volume. |
| isPrimaryLocation | boolean | Primary Location. |
| averageTicket | double | Average ticket. |
| highestTicket | double | Highest ticket. |
| category | string | Category. |
| faceToFace | string | FaceToFace. |
| phoneOrEmail | string | Phone or email. |
| internet | string | Internet. |
| rollupIndicator | string | Rollup indicator master value. |
| address1 | string | Location address. |
| address2 | string | Address 2. |
| city | string | City. |
| state | string | State. |
| zip | string | Postal code. |
| bankInformation | array | Has the below items like instName, abaNumber, etc |
| instName | string | Institution name. |
| abaNumber | string | ABA number. |
| accountTypeId | string | Account type ID. |
| accountNumber | string | Account number. |
| clearingEntity | string | |
| accountNumberDR | string | Account number. |
| clearingEntityDR | string | |
| ordinal | integer | Ordinal value. |
| deposits | long | Deposits default 1. |
| nonBankAdjustments | long | Non bank adjustments default 1. |
| depositAdjustments | long | Deposit adjustments default 1. |
| chargebackReversals | long | Chargeback reverrsals default 1. |
| interchangeAssessments | long | Interchange assessments default 1. |
| discountServices | long | Discount services default 1. |
| fees | long | Fees default 1. |
| financialAdjustments | long | Financial adjustments default 1. |
| chargebacks | long | Chargebacks default 1. |
| isPrimary | boolean | Bank is primary. |
| equipmentLocation | array | Has the below items like lineItemId, configurableLineItemId, etc. |
| lineItemId | long | Line item ID. |
| configurableLineItemId | long | Configurable line item ID. |
| attributes | array | |
| attributeName | string | Attribute name. |
| attributeValue | string | Attribute value. |
| attributeDomain | string | Attribute domain. |
| siteSurvey | object | Has the below items like siteVisitation, totalRegister, salesDeposit etc. |
| siteVisitation | string | Site visited or not. |
| deliveryTimeFrame_0_To_7 | string | Delivery time frame 0 to 7. |
| deliveryTimeFrame_8_To_14 | string | Delivery time frame 8 to 14. |
| deliveryTimeFrame_15_To_30 | string | Delivery time frame 15 to 30. |
| deliveryTimeFrame_Over_30 | string | Delivery time frame over 30. |
| businessZone | string | Business zone. |
| merchantBusinessLocation | string | Merchant business location. |
| seasonalMerchant | string | Seasonal merchant. |
| totalFloors | string | Number of floors. |
| floorOccupied | string | Floor occupied. |
| merchantsNameDisplayed | string | Merchants name displayed. |
| apartmentSquareFoot | string | Apartment square foot. |
| merchantsOwnBuildSpace | string | Merchants own build space. |
| totalRegister | integer | Total register. |
| licenceDisplayed | string | Licence displayed. |
| returnPolicy | string | Return policy. |
| separateRefundPolicy | string | Separate refund policy. |
| customerDeposit | string | Customer deposit. |
| salesDeposit | string | SalesDeposit. |
| autoRenew | string | AutoRenew. |
| rentStartTime | string | Rent start time. |
| leaseExpires | string | Lease expires. |
| landLordName | string | Landlord name. |
| landLordPhoneNumber | string | Landlord phone number. |
| createdDate | string | Created date. |
| modifiedDate | string | Modified date. |
| productsServicesSold | string | Products services sold. |
| onSiteVisitPerformed | string | OnSite visit performed. |
POST Merchantorders/Locations
data = {
"locationInformation": [
{
"dbaName": "MMIS Test dbaName1",
"merchantId": 195052,
"siteSurvey": {
"siteVisitation": "Y",
"onSiteVisitPerformed": "Y",
"deliveryTimeFrame_0":"20",
"deliveryTimeFrame_0_To_7": "20",
"deliveryTimeFrame_8_To_14": "20",
"deliveryTimeFrame_15_To_30": "20",
"deliveryTimeFrame_Over_30": "20",
"productsServicesSold": "GROCERY"
},
"mcc": "4511",
"isPrimaryLocation": true,
"faceToFace": "50",
"phoneOrEmail": "30",
"internet": "20",
"percentChipEnabled":"20",
"address1": "Calle 3 Sur #38-125",
"city": "Medellin",
"state": "AN",
"zip": "00000",
"country": "COL",
"contactPhone": "573043972968",
"email": "contact@company.com",
"bankInformation": [
{
"instName": "Bancolombia",
"abaNumber": "812386",
"accountNumber": "499145217001",
"swiftCode": "COLOCOBM",
"accountTypeId":"011",
"clearingEntity":"021",
"accountNumberDR":"499145217001",
"clearingEntityDR":"021"
}
]
}
]
}
endpoint = "/marketplace/v1/merchantorders/nmwDl/locations"
r = requests.post(url + endpoint, json=data, headers=headers)
print(r)
ENDPOINT="$URL/marketplace/v1/merchantorders/nmwDl/locations"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
"locationInformation": [
{
"dbaName": "MMIS Test dbaName1",
"merchantId": 195052,
"siteSurvey": {
"siteVisitation": "Y",
"onSiteVisitPerformed": "Y",
"deliveryTimeFrame_0":"20",
"deliveryTimeFrame_0_To_7": "20",
"deliveryTimeFrame_8_To_14": "20",
"deliveryTimeFrame_15_To_30": "20",
"deliveryTimeFrame_Over_30": "20",
"productsServicesSold": "GROCERY"
},
"mcc": "4511",
"isPrimaryLocation": true,
"faceToFace": "50",
"phoneOrEmail": "30",
"internet": "20",
"percentChipEnabled":"20",
"address1": "Calle 3 Sur #38-125",
"city": "Medellin",
"state": "AN",
"zip": "00000",
"country": "COL",
"contactPhone": "573043972968",
"email": "contact@company.com",
"bankInformation": [
{
"instName": "Bancolombia",
"abaNumber": "812386",
"accountNumber": "499145217001",
"swiftCode": "COLOCOBM",
"accountTypeId":"011",
"clearingEntity":"021",
"accountNumberDR":"499145217001",
"clearingEntityDR":"021"
}
]
}
]
}' $ENDPOINT
var options = {
method: 'POST',
url: url + '/marketplace/v1/merchantorders/nmwDl/locations',
headers: getAuthenticationHeaders(),
body: {
"locationInformation": [
{
"dbaName": "MMIS Test dbaName1",
"merchantId": 195052,
"siteSurvey": {
"siteVisitation": "Y",
"onSiteVisitPerformed": "Y",
"deliveryTimeFrame_0":"20",
"deliveryTimeFrame_0_To_7": "20",
"deliveryTimeFrame_8_To_14": "20",
"deliveryTimeFrame_15_To_30": "20",
"deliveryTimeFrame_Over_30": "20",
"productsServicesSold": "GROCERY"
},
"mcc": "4511",
"isPrimaryLocation": true,
"faceToFace": "50",
"phoneOrEmail": "30",
"internet": "20",
"percentChipEnabled":"20",
"address1": "Calle 3 Sur #38-125",
"city": "Medellin",
"state": "AN",
"zip": "00000",
"country": "COL",
"contactPhone": "573043972968",
"email": "contact@company.com",
"bankInformation": [
{
"instName": "Bancolombia",
"abaNumber": "812386",
"accountNumber": "499145217001",
"swiftCode": "COLOCOBM",
"accountTypeId":"011",
"clearingEntity":"021",
"accountNumberDR":"499145217001",
"clearingEntityDR":"021"
}
]
}
]
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
try {
String jsonString = "{\n" +
"\"locationInformation\": [\n" +
" {\n" +
" \"dbaName\": \"MMIS Test dbaName1\",\n" +
" \"merchantId\": 195052,\n" +
" \"siteSurvey\": {\n" +
" \"siteVisitation\": \"Y\",\n" +
" \"onSiteVisitPerformed\": \"Y\",\n" +
" \"deliveryTimeFrame_0\":\"20\",\n" +
" \"deliveryTimeFrame_0_To_7\": \"20\",\n" +
" \"deliveryTimeFrame_8_To_14\": \"20\",\n" +
" \"deliveryTimeFrame_15_To_30\": \"20\",\n" +
" \"deliveryTimeFrame_Over_30\": \"20\",\n" +
" \"productsServicesSold\": \"GROCERY\"\n" +
" },\n" +
" \"mcc\": \"4511\",\n" +
" \"isPrimaryLocation\": true,\n" +
" \"faceToFace\": \"50\",\n" +
" \"phoneOrEmail\": \"30\",\n" +
" \"internet\": \"20\",\n" +
" \"percentChipEnabled\":\"20\",\n" +
" \"address1\": \"Calle 3 Sur #38-125\",\n" +
" \"city\": \"Medellin\",\n" +
" \"state\": \"AN\",\n" +
" \"zip\": \"00000\",\n" +
" \"country\": \"COL\",\n" +
" \"contactPhone\": \"573043972968\",\n" +
" \"email\": \"contact@company.com\",\n" +
" \"bankInformation\": [\n" +
" {\n" +
" \"instName\": \"Bancolombia\",\n" +
" \"abaNumber\": \"812386\",\n" +
" \"accountNumber\": \"499145217001\",\n" +
" \"swiftCode\": \"COLOCOBM\",\n" +
" \"accountTypeId\":\"011\",\n\t\t" +
" \"clearingEntity\":\"021\",\n\t\t" +
" \"accountNumberDR\":\"499145217001\",\n\t\t" +
" \"clearingEntityDR\":\"021\"\n" +
" }\n" +
" ]\n" +
" }\n" +
"]\n" +
"}";
StringEntity payload = new StringEntity(jsonString);
HttpResponse response = doPost("/marketplace/v1/merchantorders/nmwDl/locations", payload);
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
JSONArray json = new JSONArray(response_string);
System.out.println("json:" + json.toString());
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$data = array (
'locationInformation' =>
array (
0 =>
array (
'dbaName' => 'MMIS Test dbaName1',
'merchantId' => 195052,
'siteSurvey' =>
array (
'siteVisitation' => 'Y',
'onSiteVisitPerformed' => 'Y',
'deliveryTimeFrame_0' => '20',
'deliveryTimeFrame_0_To_7' => '20',
'deliveryTimeFrame_8_To_14' => '20',
'deliveryTimeFrame_15_To_30' => '20',
'deliveryTimeFrame_Over_30' => '20',
'productsServicesSold' => 'GROCERY',
),
'mcc' => '4511',
'isPrimaryLocation' => true,
'faceToFace' => '50',
'phoneOrEmail' => '30',
'internet' => '20',
'percentChipEnabled' => '20',
'address1' => 'Calle 3 Sur #38-125',
'city' => 'Medellin',
'state' => 'AN',
'zip' => '00000',
'country' => 'COL',
'contactPhone' => '573043972968',
'email' => 'contact@company.com',
'bankInformation' =>
array (
0 =>
array (
'instName' => 'Bancolombia',
'abaNumber' => '812386',
'accountNumber' => '499145217001',
'swiftCode' => 'COLOCOBM',
'accountTypeId' => '011',
'clearingEntity' => '021',
'accountNumberDR' => '499145217001',
'clearingEntityDR' => '021',
),
),
),
),
)
$data_json = json_encode($data);
$headers = array(
'date: ' . $date,
'Authorization: ' . $hmacAuth,
'Content-Type: application/json',
'Content-Length: ' . strlen($data_json)
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/marketplace/v1/merchantorders/nmwDl/locations");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_json);
$res = curl_exec($ch);
echo($res);
?>
The above command returns JSON structured like this:
{
"hashedOrderId": "OpppE",
"primaryMerchantId": 195052
}
This endpoint collects information about each location of the business for merchant boarding purposes.
Request
POST /marketplace/v1/merchantorders/{orderId}/locations
In the request URL, use the orderId as it was returned in the response of the POST Merchantorders API.
The endpoint takes a JSON object as input, which contains following information.
| Parameter | Required | Data Type | Short Description |
|---|---|---|---|
| locationInformation | ✔ | array | Array of (minimum one) objects, each containing the information about each business location, including e-commerce locations. |
| dbaName | ✔ | string | Company name. |
| merchantId | ✔ | long | Identifier of merchant. |
| averageTicket | double | Average ticket. | |
| mccDescription | string | MCC description. | |
| mcc | ✔ | string | MCC Code. |
| annualVolume | double | Annual volume. | |
| highestTicket | double | Highest ticket. | |
| isPrimaryLocation | ✔ | boolean | Primary location true or false. |
| stateInscription | string | State. | |
| cityInscription | string | City. | |
| contactTime | string | Time format HH:MM. | |
| faceToFace | ✔ | string | Percentage face to face (can’t exceed 100%). |
| phoneOrEmail | ✔ | string | Percentage phone or email (can’t exceed 100%). |
| internet | ✔ | string | Percentage internet (can’t exceed 100%). |
| percentChipEnabled | ✔ | string | Percentage percent chip enabled (can’t exceed 100%). |
| businessCurrentlyOpenToDiligence | string | ||
| businessClosedReasonToDiligence | string | ||
| businessOpenDaysPerWeekToDiligence | string | ||
| businessOpenTimeMondayToDiligence | string | ||
| businessOpenTimeTuesdayToDiligence | string | ||
| businessOpenTimeWednesdayToDiligence | string | ||
| businessOpenTimeThursdayToDiligence | string | ||
| businessOpenTimeFridayToDiligence | string | ||
| businessOpenTimeSaturdayToDiligence | string | ||
| businessOpenTimeSundayToDiligence | string | ||
| businessCloseTimeMondayToDiligence | string | ||
| businessCloseTimeTuesdayToDiligence | string | ||
| businessCloseTimeWednesdayToDiligence | string | ||
| businessCloseTimeThursdayToDiligence | string | ||
| businessCloseTimeFridayToDiligence | string | ||
| businessCloseTimeSaturdayToDiligence | string | ||
| businessCloseTimeSundayToDiligence | string | ||
| rollupIndicator | string | Rollup indicator master value. | |
| category | string | ||
| address1 | ✔ | string | Street address. |
| address2 | string | Second line of street address, if applicable. i.e. Unit, Floor, Suite, etc. | |
| address3 | string | Third line of street address. | |
| city | ✔ | string | City. |
| state | ✔ | string | State. |
| zip | ✔ | string | ZIP/postal code. |
| country | ✔ | string | Country. |
| contactPhone | ✔ | string | Phone number. |
string | Email. | ||
| equipmentLocation | array | Contains lineItemId, configurableLineItemId and attributes. | |
| lineItemId | long | Line item ID. | |
| configurableLineItemId | long | Configurable line Item ID. | |
| attributes | array | Contains attributeName, attributeValue and attributeDomain. | |
| attributeName | string | Attribute name. | |
| attributeValue | string | Attribute value. | |
| attributeDomain | string | Attribute domain. | |
| bankInformation | ✔ | array | Array of (minimum one) object(s) that collects the ACH information. |
| instName | ✔ | string | Institution name. |
| abaNumber | ✔ | string | ABA number. |
| accountTypeId | ✔ | string | |
| accountNumber | ✔ | string | Account number. |
| clearingEntity | ✔ | string | |
| accountNumberDR | ✔ | string | Account number. |
| clearingEntityDR | ✔ | string | |
| ordinal | integer | Ordinal value. | |
| deposits | long | The account the merchant wants transactions to go to. | |
| nonBankAdjustments | long | The account the merchant wants the nonBankadjustments to be withdrawn from. | |
| depositAdjustments | long | The account the merchant wants the deposit adjustments to go to. | |
| chargebackReversals | long | The account the merchant wants the chargeback reversals to go to. | |
| interchangeAssessments | long | The account the merchant wants the interchange assessments to be withdrawn from. | |
| discountServices | long | The account the merchant wants the discountservices to be withdrawn from. | |
| fees | long | The account the merchant wants the account fees to be withdrawn from. | |
| financialAdjustments | long | The account the merchant wants the financial adjustments to go to. | |
| chargebacks | long | The account the merchant wants the chargeback debits to be withdrawin from. | |
| bankTelephone | string | Telephone number for the settlement bank, do not use dashes, this is optional field. | |
| bankContactName | string | The name of the contact who works at the bank, this is optional field and bank isn’t going to send. | |
| bankCity | string | City where the settlement bank account is located (domiciled). | |
| iban | string | Is a series of alphanumeric characters (up to 34, dependent on country) that uniquely identifies an account held at any bank anywhere in the world. Mandatory to EU Bank accounts only. There are no IBANS in Columbia at this time so will send as “spaces”. | |
| swiftCode | string | A SWIFT (Society for Worldwide Interbank Financial Telecommunication) code is an international bank code that identifies particular banks worldwide consisting of 8 or 11 characters. Mandatory for international wire transfers. | |
| isPrimary | boolean | Bank is primary | |
| accountName | string | The Merchant’s Account Name at the Settlement Bank. | |
| sortCode | string | The sort code, which is a six-digit number, is usually formatted as three pairs of numbers, for example 12-34-56. It identifies both the bank and the branch where the account is held. Merchant’s bank/branch code. | |
| delayDays | integer | Ddays = Delay days. This field indicates the number of days to hold payment to the merchant. Use of this value is dependent on the payment interface supported, default to ‘000’ if not relevant for the merchant being set up. Bank will use ‘000’. | |
| creditDebit | string | Account type. | |
| bankTelephoneForReceivables | string | ||
| bankNameForReceivables | string | ||
| bankContactNameForReceivables | string | ||
| bankCityForReceivables | string | ||
| swiftCodeForReceivables | string | ||
| paymentFormatForReceivables | string | ||
| ibanForReceivables | string | ||
| accountNameForReceivables | string | ||
| sortCodeForReceivables | string | ||
| delayDaysForReceivables | string | ||
| siteSurvey | ✔ | object | Has the below items like siteVisitation, onSiteVisitPerformed, deliveryTimeFrame etc. |
| siteVisitation | ✔ | string | Is there going to be a siteVisit. |
| onSiteVisitPerformed | ✔ | string | Site visited or not. |
| deliveryTimeFrame_0 | ✔ | string | Delivery time frame 0. |
| deliveryTimeFrame_0_To_7 | ✔ | string | Delivery time frame 0 to 7. |
| deliveryTimeFrame_8_To_14 | ✔ | string | Delivery time frame 8 to 14. |
| deliveryTimeFrame_15_To_30 | ✔ | string | Delivery time frame 15 to 30. |
| deliveryTimeFrame_Over_30 | ✔ | string | Delivery time frame over 30. |
| productsServicesSold | ✔ | string | Products services sold. |
| returnPolicy | string | Return policy. | |
| separateRefundPolicy | string | Separate refund policy. |
Response
The endpoint returns an object containing merchant location details and the orderId.
| Parameter | Data Type | Description |
|---|---|---|
| orderId | string | The unique identifier of an order returned after successful submission. |
| primaryMerchantId | string | Primary merchant identifier. |
| merchantIdList | array | Array of merchantId’s |
| merchantId | string |
POST Merchantorders/status
data = {
"orderIds":["OpppE"]
}
endpoint = "/marketplace/v1/merchantorders/status"
r = requests.post(url + endpoint, json=data, headers=headers)
print(r)
ENDPOINT="$URLmarketplace/v1/merchantorders/status"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
"orderIds":["OpppE"]
}' $ENDPOINT
var options = {
method: 'POST',
url: url + '/marketplace/v1/merchantorders/status',
headers: getAuthenticationHeaders(),
body: {
"orderIds":["OpppE"]
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
try {
String jsonString = "{\n" +
"\orderIds\":["\OpppE\"]
}\n"
StringEntity payload = new StringEntity(jsonString);
HttpResponse response = doPost("/marketplace/v1/merchantorders/status", payload);
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
JSONArray json = new JSONArray(response_string);
System.out.println("json:" + json.toString());
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$data = {
'orderIds' =>
array (
0 => 'OpppE'
)
}
$data_json = json_encode($data);
$headers = array(
'date: ' . $date,
'Authorization: ' . $hmacAuth,
'Content-Type: application/json',
'Content-Length: ' . strlen($data_json)
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/marketplace/v1/merchantorders/status");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_json);
$res = curl_exec($ch);
echo($res);
?>
The above command returns JSON structured like this:
{
"orders": [
{
"orderId": "OpppE",
"lastUpdatedDate": "2020-01-06 19:56:19",
"merchants": [
{
"merchantId": "nRKyz",
"lastUpdatedDate": "2020-01-06 19:56:19",
"status": "Credit Approved",
"platform": "SOUTH",
"parentMerchantIdentifier": "65622870",
"merchantIdentifier": "65622871"
}
]
}
]
}
Request
POST /marketplace/v1/merchantorders/status
In the request URL, use the orderId as it was returned in the response of the POST Merchantorders API.
The endpoint takes a JSON object as input, which contains following information.
| Parameter | Required | Data Type | Short Description |
|---|---|---|---|
| orderIds | ✔ | String | Order id |
Response
The endpoint returns an object containing merchant location details and the orderId.
| Parameter | Data Type | Description |
|---|---|---|
| orders | array | The unique identifier of an order returned after successful submission. |
| orderId | string | Primary merchant identifier. |
| lastUpdatedDate | string | Last date updated. |
| merchants | array | Array of merchant objects. |
| merchantId | long | Internal merchant ID. |
| lastUpdatedDate | string | Last date. |
| status | string | Last update. |
| merchantIdentifier | string | Status of merchant. |
| parentMerchantIdentifier | string | |
| platform | string |