Marketplace Manage
GET Merchant ID
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/14352823"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/14352823"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/14352823',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/14352823");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/14352823");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"result":{
"merchantId":987654321,
"externalMerchantId":"",
"customMerchantId":"",
"taxId":"",
"ompSysId":"",
"mid":"300400500769",
"mccIso":"8398",
"tradeName":"TEST DBA",
"hierarchyLevel":"100",
"name":"TEST DBA LEGAL",
"businessType":"",
"baseCurrencyCode":"",
"description":"",
"multiCurrencyIndicator":"N",
"systemIndicator":"",
"affiliateName":"TEST DBA",
"rebateIndicator":"N",
"discountFieldMc":"T",
"discountFieldVisa":"T",
"discountFieldDiscover":"",
"relationshipManagerCode":"ABC",
"internalMerchantId":"",
"leaseCompCode":"00",
"pricingMethod":"001",
"sourceSystemId":"",
"autoBillingIndicator":"",
"subPlatformCode":"NO",
"seasonalIndicator":"Y",
"businessWebsiteAddress":"www.test@firstdata.com",
"bypassFiid":"",
"primaryNetworkCode":"M",
"secondaryNetworkCode":"",
"transactionKeyedPercent":"0",
"mcAnnualVolume":"17658",
"visaAnnualVolume":"5229",
"leaseCompanyCode":"00",
"abaNumber":"1779",
"ddaNumber":"5970",
"organisationType":"Limited Liability",
"emvIndicator":"Y",
"mcAverageTicket":"551.00",
"visaAverageTicket":"551.00",
"telecheckContactPerson":"",
"telecheckContactPhone":"",
"uniqueId":987654321
}
}
Retrieve information about the merchant.
This service will retrieve the information for the merchant within the appropriate hierarchy.
Request
GET /api/manage/merchants/{merchantId}
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| externalMerchantId | Client-specific merchant number that is cross-referenced to the FD merchant number (MID). |
| customMerchantId | Reserved for future use. |
| taxId | Merchant’s Tax Identification Number. |
| ompSysId | Omnipay System ID. |
| mid | FD system generated merchant number. |
| mccIso | FD reporting standard industry code that corresponds to the Merchant Category Code. |
| tradeName | Merchant’s “Doing Business As” (DBA) name. |
| hierarchyLevel | Identifies the MID’s level in the hierarchy. (refer to: hierarchyLevel Values). |
| name | Legal Name of the merchant. |
| businessType | Indicates the type of business for the merchant |
| baseCurrencyCode | Alpha 3 Base Currency Code of the merchant that will drive the currency of summarized data views. |
| description | User defined merchant description. |
| multicurrencyIndicator | Indicates whether the merchant supports multi-currency processing. |
| systemIndicator | Reserved for future use. |
| affiliateName | Merchant’s “Doing Business As” (DBA) name. |
| rebateIndicator | Enhanced billback program to charge merchant a surcharge, in addition to any billback fees. (refer to: rebateIndicator Values). |
| discountFieldMc | Discount option for MasterCard. (refer to: discountFieldMC Values). |
| discountFieldVisa | Discount option for Visa. (refer to: discountFieldVisa Values). |
| discountFieldDiscover | Discount option for Discover. (refer to: discountFieldDiscover Values). |
| relationshipManagerCode | Identifies which relationship manager is responsible for the account. This code is used to obtain the manager’s name and account portfolio from the RM table. |
| internalMerchantId | Reserved for future use. |
| leaseCompCode | Reserved for future use. |
| pricingMethod | Identifies the best Interchange level at which the outlet has been priced for each entitlement. For the pricing method for each entitlement. (refer to: GET /api/manage/merchants/:merchantId/entitlements). |
| sourceSystemId | Reserved for future use. |
| autoBillingIndicator | Determines whether or not merchant is going to get a Billback. (refer to: autoBillingIndicator Values for possible values). |
| subPlatformCode | Reserved for future use. |
| seasonalIndicator | Identifies whether a merchant is open for specific seasons only. (refer to: seasonalIndicator Values for possible values). |
| businessWebsiteAddress | Universal resource locator field which captures the merchants web site. |
| bypassFiid | Reserved for future use. |
| primaryNetworkCode | Indicates the Network (front end) that the terminal communicates with and merchant process on. (refer to: primaryNetworkCode Values for possible North Platform Front ends). |
| secondaryNetworkCode | The merchant may need a secondary network for additional equipment not supported on the primary network or if converting from Network to Network. (refer to: secondaryNetworkCode Values for valid Secondary Network options). |
| transactionKeyedPercent | Indicates percentage of manually keyed transactions. The system calculates percentage of swiped transactions. |
| mcAnnualVolume | The anticipated annual volume of transactions for MasterCard. |
| visaAnnualVolume | The anticipated annual volume of transactions for Visa. |
| leaseCompanyCode | The name of the Company who holds the Lease. (refer to: leaseCompanyCode Values). |
| abaNumber | Last 4 positions of the transit routing number associated with the funding DDA. |
| ddaNumber | Last 4 positions of the funding demand deposit account, which may be a checking or savings account. |
| organisationType | Indicates the type of ownership. |
| emvIndicator | Indicates if a merchant has signed up for European MC & Visa chip functionality. Does not mean the terminals they have are EMV compatible, the default is Yes on boarding regardless of what equipment they have. |
| mcAverageTicket | MC Average Ticket Size. |
| visaAverageTicket | Visa Average Ticket Size. |
| telecheckContactPerson | Reserved for future use. |
| telecheckContactPhone | Reserved for future use. |
| uniqueId | Same as merchantId. |
discountFieldMc discountFieldVisa discountFieldDiscover values
| Value | Meaning |
|---|---|
"A" | RT DISCOUNT RATES. |
"B" | PF PROCESSING FEES. |
"C" | IP INTERCHANGE PLUS. |
"D" | GD GRID. |
"E" | TD TIERED DISC 0100. |
"F" | T1 TIERED DISC 01. |
"G" | T2 TIERED DISC 02. |
"H" | T3 TIERED DISC 03. |
"I" | T4 TIERED DISC 04. |
"J" | DM DDMMY ACCOUNT. |
"K" | HD HOLD ACCOUNT. |
"L" | T5 TIERED DISC 05. |
"M" | T6 TIERED DISC 06. |
"N" | T7 TIERED DISC 07. |
"O" | T8 TIERED DISC 08. |
"P" | T9 TIERED DISC 09. |
"Q" | T10 TIERED DISC 10. |
"R" | T11 TIERED DISC 11. |
"S" | T12 TIERED DISC 12. |
"T" | T13 TIERED DISC 13. |
"U" | T14 TIERED DISC 14. |
"V" | T15 TIERED DISC 15. |
"W" | T16 TIERED DISC 16. |
"X" | T17 TIERED DISC 17. |
"Y" | T18 TIERED DISC 18. |
"Z" | T19 TIERED DISC 19. |
"1" | T20 TIERED DISC 20 (For participating alliance only). |
"2" | T21 TIERED DISC 21 (For participating alliance only). |
"3" | 3Tier-Retail (For participating alliance only). |
"4" | 3Tier-Moto (For participating alliance only). |
"5" | 2Tier-Moto (For participating alliance only). |
"6" | 9Tier-Retail (For participating alliance only). |
"7" | T27 TIERED DISC 27 (For participating alliance only). |
"8" | ISO Tier Table 8Y. |
"9" | ISO Tier Table 9Z. |
"W01" | W01 Two Tiered (For participating alliance only). |
"W02" | W02 Three Tiered (For participating alliance only). |
"(None)" | |
"T23" | T23-TIERED DISC 23 (For participating alliance only). |
"T24" | T24-TIERED DISC 24 (For participating alliance only). |
"CHS" | CHS-TIER DISCOUNT 43 (For participating alliance only). |
hierarchyLevel values
| Platform. | Merchant Type | Level in Hierarchy |
|---|---|---|
| North | 120 (Location) | lvl1Id. |
100 (Corporate) | lvl2Id. | |
90 (Lead Corporate) | lvl3Id. | |
60 (Agent) | lvl4Id. | |
50 (Bank) | lvl5Id. | |
40 (Business/Owner) | lvl6Id. |
multiCurrencyIndicator values
| Value | Meaning |
|---|---|
"B" | DCC on GMA. |
"C" | Lloyds. |
"D" | Dynamic Currency Conversion. |
"E" | Global ePricing. |
"F" | Foreign Processing. |
"I" | International / India. |
"N" | None. |
"O" | OmniPay. |
"T" | Taiwan. |
"X" | Foreign Processing. |
rebateIndicator values
| Value | Meaning |
|---|---|
"B" | Blank. |
"C" | CMCL Crd Pln Cds MC/VI. |
"F" | Exclude Auto Fuel Visa. |
"G" | Government Plan Cds VI. |
"L" | Fuel Crd Pln Cds MC/VI. |
"M" | Auto Bill Surchg Mrcht – (30D must be present to populate this value). |
"N" | No Auto Bill Surcharge. |
"R" | Corp Crd Pln Cds MC/VI. |
"Y" | Auto Bill Surcharge of .50% chainNumber - Chain-level CHAIN NUMBER associated with the outlet. |
autoBillingIndicator values
| Value | Meaning |
|---|---|
"S" | Auto billback with reverse billbacks. |
"A" | Auto billback with no reverse billbacks. |
"P" | Merchant not on auto billback. |
"Y" | Auto billback on. |
"N" | Auto billback off. |
seasonalIndicator values
| Value | Meaning |
|---|---|
| “Y” | Seasonal merchant on. |
| “N” | Seasonal merchant off. |
primaryNetworkCode values
| Value | Meaning |
|---|---|
"A" | Nashville. |
"B" | Buypass. |
"C" | Cardnet (can only be primary). |
"D" | NDC. |
"E" | EDS Aurora. |
"F" | FDR. |
"G" | Big M. |
"J" | Compass. |
"M" | MAPP. |
"N" | Nova. |
" " | Other. |
"P" | Paper. |
"Q" | Base 24. |
"R" | ADS. |
"S" | PNS. |
"T" | Telemoney. |
"U" | UPPS. |
"V" | Vital. |
"X" | Telecheck. |
secondaryNetworkCode values
| Value | Meaning |
|---|---|
"None" | |
"A" | Nashville. |
"B" | Buypass. |
"D" | NDC. |
"E" | EDS Aurora. |
"F" | FDR. |
"G" | Big M. |
"J" | Compass. |
"M" | MAPP. |
"N" | Nova. |
" " | Other. |
"Q" | Base 24. |
"R" | ADS. |
"S" | PNS. |
"T" | Telemoney. |
"U" | UPPS. |
"V" | Vital. |
"X" | Telecheck. |
leaseCompanyCode values
| Value | Meaning |
|---|---|
"01" | LADCO. |
"02" | NORTHERN. |
"03" | 3 RD PTY. |
"04" | FDLS. |
"05" | CIT. |
organisationType values
| Value | Meaning |
|---|---|
"D" | CORPORATION PRIVATE. |
"E" | CORP PUBLICLY TRADED. |
"F" | NON PROFIT. |
"G" | GOVERNMENT. |
"M" | LLC PRIVATE. |
"N" | LLC PUBLICLY TRADED. |
"Q" | PARTNERSHIP PRIVATE. |
"R" | PARTNERSHIP PUBLICLY TRADED. |
"S" | SOLE PROPRIETORSHIP. |
"Space" | Not applicable. |
POST Merchant Search
# Don't forget to add your HMAC Authorization Headers
data = {
"merchantId":987654321,
"hierarchyLevel":"100",
"sort":"level"
}
endpoint = "/api/manage/merchantsearch"
r = requests.post(url + endpoint, json=data, headers=headers)
print(r.text)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchantsearch"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
"merchantId": 987654321,
"hierarchyLevel": "100",
"sort": "level"
}' $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = { method: 'POST',
url: url + '/api/manage/merchantsearch',
headers: getAuthenticationHeaders(),
body:
{
"merchantId": 987654321,
"hierarchyLevel": "100",
"sort": "level"
},
json: true };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
// Don't forget to add your HMAC Authorization Headers
try {
String jsonString = "{\n" +
" \"merchantId\": 987654321,\n" +
" \"hierarchyLevel\": \"100\",\n" +
" \"sort\": \"level\"\n" +
"}";
StringEntity payload = new StringEntity(jsonString);
HttpResponse response = doPost("/api/manage/merchantsearch", payload);
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$data = array (
'merchantId' => 801098765432113,
'hierarchyLevel' => '100',
'sort' => 'level',
);
$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 . "/api/manage/merchantsearch");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"mid":"300400500769",
"merchantId":987654321,
"hierarchyLevel":"100",
"hierarchyLevelAbbreviation":"CORP",
"externalMerchantId":"000001234567879012341",
"dbaName":"TEST DBA",
"city":"MANCHESTER",
"state":"IL",
"zipCode":"12345"
},
{
"mid":"341414141414",
"merchantId":14223347,
"hierarchyLevel":"120",
"hierarchyLevelAbbreviation":"LCTN",
"externalMerchantId":"",
"dbaName":"BLUE STORE",
"city":"LIVERPOOL",
"state":"",
"zipCode":"L1 0BE"
}
],
"pagination":{
"rowCount":2,
"pageCount":1,
"countPerPage":3000,
"page":1
}
}
Example error response. This response indicated that the provided information (TIN information) could not be associated with a known record.
{
"code": 1030,
"additional message": "Error received from Idology Question service",
"message": "Error Retrieving Idology Questions"
}
Search for merchant by the set of criteria.
Request
POST /api/manage/merchantsearch
| Parameter | Description |
|---|---|
| externalMerchantId | External ID on the Merchant Lookup dialog. Can be partially searched. |
| state | State code (for example, CA, AZ, NE, NV). State Abbr. on the Merchant Lookup dialog. Can be partially searched. |
| city | City name. City on the Merchant Lookup dialog. Can be partially searched. |
| mid | Merchant Account Number. Hierarchy ID on the Merchant Lookup dialog. |
| merchantId | System generated Merchant ID |
| dbaName | Doing Business As name. DBA Name on the Merchant Lookup dialog. Can be partially searched. |
| zipCode | Postal Code on the Merchant Lookup. Can be partially searched. |
| hierarchyLevel | Hierarchy Level on the Merchant Lookup |
| sort | Specifies on what field sorting is done, if provided. |
Note: This is the POST request because it uses sensitive data as parameters. Some of the input parameters may be skipped, but not all.
The result will be broken down into pages based on countPerPage value.
Response
List of items with the following fields:
| Parameter | Description |
|---|---|
| mid | Merchant Account Number. Hierarchy ID on the Merchant Lookup dialog. |
| hierarchyLevel | Hierarchy Level on the Merchant Lookup (refer to: hierarchyLevel Values). |
| hierarchyLevelAbbreviation | Text abbreviation for the hierarchy level (refer to: hierarchyLevelAbbreviation Values). |
| externalMerchantId | External ID on the Merchant Lookup dialog. It is merchant number that is sent to the card scheme and appears in acquirer contracts with the merchant. |
| merchantId | Business Track system generated unique identifier. |
| dbaName | Merchant’s “Doing Business As” (DBA) name (Outlet location). DBA Name on the Merchant Lookup dialog. |
| city | Merchant’s “Doing Business As” (DBA) city name. City on the Merchant Lookup dialog. |
| state | Merchant’s “Doing Business As” (DBA) State code (for example, CA, AZ, NE, NV). State Abbr. on the Merchant Lookup dialog. |
| zipCode | Merchant’s “Doing Business As” (DBA) Zip code or Postal Code on the Merchant Lookup. |
hierarchyLevelAbbreviation values
| Platform | Type | Merchant Type | Level in Hierarchy |
|---|---|---|---|
| NORTH | BANK | 120 (Location) | lvl1Id. |
BSNS | 100 (Corporate) | lvl2Id. | |
AGNT | 90 (Lead Corporate) | lvl3Id. | |
LEAD | 60 (Agent) | lvl4Id. | |
CORP | 50 (Bank) | lvl5Id. | |
LCTN | 40 (Business/Owner) | lvl6Id. |
GET Merchant Contact By ID
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/contacts/00011122"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/contacts/00011122"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/contacts/00011122 ',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/contacts/00011122");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/contacts/00011122");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"result":{
"contactId":00011122,
"merchantId":987654321,
"contactType":"DBA",
"addressLine1":"123 Main Street",
"addressLine2":"134",
"postalCode":"12345",
"city":"ANYTOWN",
"state":"NY",
"country":"USA",
"phoneNumber":"1234567890",
"emailAddress":"TEST@FIRSTDATA.COM",
"attentionToFirstName":"",
"attentionToLastName":"",
"firstName":"",
"lastName":"",
"fullName":"",
"uniqueId":987654321,
"attentionToFullName":""
}
}
Retrieves merchants contact list.
Request
GET /api/manage/merchants/{merchantId}/contacts/{contactId}
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| contactId | System generated ID of the contact. |
Response
This endpoint returns an object representing a contact type and associated information.
| Parameter | Description |
|---|---|
| contactId | Unique identifier for the contact. |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| contactType | "BIL": Billing address."STM": Statement delivery address. "DBA": Doing Business As address. |
Attributes if contactType is "BIL":
| Parameter | Description |
|---|---|
| addressLine1 | Merchant bill-to address line 1. |
| addressLine2 | Merchant bill-to city and state. |
| postalCode | Merchant bill-to ZIP or Postal code. |
| city | Merchant bill-to city. |
| state | Merchant bill-to state. |
| country | Merchant bill-to country. |
| phoneNumber | Merchant bill-to telephone number. |
| emailAddress | |
| attentionToFirstName | Reserved for future use. |
| attentionToLastName* | Reserved for future use. |
| firstName | Reserved for future use. |
| lastName | Reserved for future use. |
| fullName | Reserved for future use. |
| uniqueId | Reserved for future use. |
| attentionToFullName | Reserved for future use. |
Attributes if contactType is "DBA": |
| Parameter | Description |
|---|---|
| addressLine1 | Merchant Affiliate / ‘Doing Business As’ address line 1 |
| addressLine2 | Merchant Affiliate / 'Doing Business As’ city and state |
| postalCode | Merchant Affiliate / 'Doing Business As’ ZIP or Postal code |
| city | Merchant Affiliate / 'Doing Business As’ city |
| state | Merchant Affiliate / 'Doing Business As’ state |
| country | Merchant Affiliate / 'Doing Business As’ country |
| phoneNumber | Merchant Affiliate / 'Doing Business As’ telephone number |
| emailAddress | Reserved for future use. |
| attentionToFirstName | Reserved for future use. |
| attentionToLastName* | For future use. |
| firstName | Reserved for future use. |
| lastName | Reserved for future use. |
| fullName | Reserved for future use. |
| uniqueId | Reserved for future use. |
| attentionToFullName | Reserved for future use. |
GET Merchant Contacts
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/contacts/?contactType=DBA"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/contacts/?contactType=DBA"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/contacts/?contactType=DBA',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/contacts/?contactType=DBA");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/contacts/?contactType=DBA");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"result":{
"contactId":00011122,
"merchantId":987654321,
"contactType":"DBA",
"addressLine1":"123 Main Street",
"addressLine2":"123",
"postalCode":"12345",
"city":"ANYTOWN",
"state":"NY",
"country":"USA",
"phoneNumber":"1234567890",
"emailAddress":"TEST@FIRSTDATA.COM",
"attentionToFirstName":"",
"attentionToLastName":"",
"firstName":"",
"lastName":"",
"fullName":"",
"uniqueId":987654321,
"attentionToFullName":""
}
}
Retrieves merchants contact list.
Request
GET /api/manage/merchants/{merchantId}/contacts
| Parameter | Description |
|---|---|
| no input |
Optional query parameter: contactType. Possible values: "DBA", "STM", "BIL". i.e. GET /api/manage/merchants/{merchantId}/contacts?contactType=DBA
Response
This endpoint returns an object representing a contact type and associated information.
| Parameter | Description |
|---|---|
| contactId | Unique identifier for the contact. |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| contactType | "BIL": Billing address."STM": Statement delivery address. "DBA": Doing Business As address. |
Attributes if contactType is "BIL":
| Parameter | Description |
|---|---|
| addressLine1 | Merchant bill-to address line 1. |
| addressLine2 | Merchant bill-to city and state. |
| postalCode | Merchant bill-to ZIP or Postal code. |
| city | Merchant bill-to city. |
| state | Merchant bill-to state. |
| country | Merchant bill-to country. |
| phoneNumber | Merchant bill-to telephone number. |
| emailAddress | |
| attentionToFirstName | Reserved for future use. |
| attentionToLastName | Reserved for future use. |
| firstName | Reserved for future use. |
| lastName | Reserved for future use. |
| fullName | Reserved for future use. |
| uniqueId | Reserved for future use. |
| attentionToFullName | Reserved for future use. |
Attributes if contactType is "DBA": |
| Parameter | Description |
|---|---|
| addressLine1 | Merchant Affiliate / ‘Doing Business As’ address line 1 |
| addressLine2 | Merchant Affiliate / 'Doing Business As’ city and state |
| postalCode | Merchant Affiliate / 'Doing Business As’ ZIP or Postal code |
| city | Merchant Affiliate / 'Doing Business As’ city |
| state | Merchant Affiliate / 'Doing Business As’ state |
| country | Merchant Affiliate / 'Doing Business As’ country |
| phoneNumber | Merchant Affiliate / 'Doing Business As’ telephone number |
| emailAddress | Reserved for future use. |
| attentionToFirstName | Reserved for future use. |
| attentionToLastName* | For future use. |
| firstName | Reserved for future use. |
| lastName | Reserved for future use. |
| fullName | Reserved for future use. |
| uniqueId | Reserved for future use. |
| attentionToFullName | Reserved for future use. |
GET Merchant Hierarchy by ID
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/hierarchies/100/90001234"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/hierarchies/100/90001234"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/hierarchies/100/90001234',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/hierarchies/100/90001234");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/hierarchies/100/90001234");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"result":{
"hierarchyId":90001234,
"merchantId":987654321,
"hierarchyLevel":"120",
"dateFrom":"1000-01-01T00:00:00.000Z",
"dateTo":"9999-12-31T23:59:59.000Z",
"lvl1Id":14223347,
"lvl2Id":801013,
"lvl3Id":202025,
"lvl4Id":30303,
"lvl5Id":304049,
"lvl6Id":305059,
"lvl7Id":457,
"lvl1Number":"341414141414",
"lvl2Number":"351515151515",
"lvl3Number":"361616161616",
"lvl4Number":"371717171717",
"lvl5Number":"381818181818",
"lvl6Number":"391919191919",
"lvl7Number":"888",
"uniqueId":987654321
}
}
Service will retrieve the hierarchy item based on merchantlId, hierarchyLevel and hierarchyId.
The appropriate field to search by merchantId from the "lvl1Id" to "lvl6Id" will be selected based on the hierarchyLevel. (refer to: hierarchyLevel Values).
Request
GET /api/manage/merchants/{merchantId}/hierarchies/{hierarchyLevel}/{hierarchyId}
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| hierarchyLevel | merchant hierarchy type as described in Hierarchy Definition. (refer to: hierarchyLevel Values). |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| hierarchyId | Unique identifier for the hierarchy. |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| dateFrom | Date when hierarchy became effective. |
| dateTo | date when hierarchy expired. |
| lvl1Id | Outlet level Merchant ID. |
| lvl2Id | Chain level Merchant ID. |
| lvl3Id | Lead Corporate level Merchant ID. |
| lvl4Id | Agent level Merchant ID. |
| lvl5Id | Bank level Merchant ID. |
| lvl6Id | Business Chain level Merchant ID. |
| lvl7Id | Bank marker. |
| lvl1Number | Outlet level MID. |
| lvl2Number | Chain level MID. |
| llvl3Number | Lead Corporate level MID. |
| lvl4Number | Agent level MID. |
| lvl5Number | Bank level MID. |
| lvl6Number | Business Chain level MID. |
| lvl7Number | Bank Marker ID. |
| uniqueId | The same as merchantId. |
GET Merchant Hierarchy
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/hierarchies/100?hierarchydate=2019-04-18"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/hierarchies/100?hierarchydate=2019-04-18"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/hierarchies/100?hierarchydate=2019-04-18',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/hierarchies/100?hierarchydate=2019-04-18");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/hierarchies/100?hierarchydate=2019-04-18");
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:
Success response
{
"responseCode": "success",
"reasonCode": "success",
"results": [{
"hierarchyId": 90002345,
"merchantId": 14223347,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223351,
"lvl2Id": 222222,
"lvl3Id": ,
"lvl4Id": 444444,
"lvl5Id": 555555,
"lvl6Id": 666666,
"lvl7Id": 777,
"lvl1Number": "341414141414",
"lvl2Number": "351515151515",
"lvl3Number": "",
"lvl4Number": "371717171717",
"lvl5Number": "381818181818",
"lvl6Number": "391919191919",
"lvl7Number": "888",
"uniqueId": 14223347
}, {
"hierarchyId": 90002346,
"merchantId": 14223348,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223352,
"lvl2Id": 222221,
"lvl3Id": 333331,
"lvl4Id": 444441,
"lvl5Id": 555551,
"lvl6Id": 666661,
"lvl7Id": 771,
"lvl1Number": "441414141414",
"lvl2Number": "451515151515",
"lvl3Number": "461616161616",
"lvl4Number": "471717171717",
"lvl5Number": "481818181818",
"lvl6Number": "491919191919",
"lvl7Number": "889",
"uniqueId": 14223348
}, {
"hierarchyId": 90002347,
"merchantId": 14223349,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223353,
"lvl2Id": 222223,
"lvl3Id": 333333,
"lvl4Id": 444443,
"lvl5Id": 555553,
"lvl6Id": 666663,
"lvl7Id": 773,
"lvl1Number": "541414141414",
"lvl2Number": "551515151515",
"lvl3Number": "561616161616",
"lvl4Number": "571717171717",
"lvl5Number": "581818181818",
"lvl6Number": "591919191919",
"lvl7Number": "890",
"uniqueId": 14223349
}, {
"hierarchyId": 90002348,
"merchantId": 14223350,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223354,
"lvl2Id": 222224,
"lvl3Id": ,
"lvl4Id": 444444,
"lvl5Id": 555554,
"lvl6Id": 666664,
"lvl7Id": 774,
"lvl1Number": "641414141414",
"lvl2Number": "651515151515",
"lvl3Number": "",
"lvl4Number": "671717171717",
"lvl5Number": "681818181818",
"lvl6Number": "691919191919",
"lvl7Number": "891",
"uniqueId": 14223350
}, {
"hierarchyId": 90002349,
"merchantId": 14223351,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223355,
"lvl2Id": 222225,
"lvl3Id":
"lvl4Id": 444445,
"lvl5Id": 555555,
"lvl6Id": 666665,
"lvl7Id": 775,
"lvl1Number": "741414141414",
"lvl2Number": "751515151515",
"lvl3Number": "",
"lvl4Number": "771717171717",
"lvl5Number": "781818181818",
"lvl6Number": "791919191919",
"lvl7Number": "892",
"uniqueId": 14223351
}, {
"hierarchyId": 90002350,
"merchantId": 14223352,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223356,
"lvl2Id": 222226,
"lvl3Id": ,
"lvl4Id": 444446,
"lvl5Id": 555556,
"lvl6Id": 666666,
"lvl7Id": 776,
"lvl1Number": "841414141414",
"lvl2Number": "851515151515",
"lvl3Number": "",
"lvl4Number": "871717171717",
"lvl5Number": "881818181818",
"lvl6Number": "891919191919",
"lvl7Number": "893",
"uniqueId": 14223352
}, {
"hierarchyId": 14223351,
"merchantId": 14223353,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223357,
"lvl2Id": 222227,
"lvl3Id": 333337,
"lvl4Id": 444447,
"lvl5Id": 555557,
"lvl6Id": 666667,
"lvl7Id": 778,
"lvl1Number": "941414141414",
"lvl2Number": "951515151515",
"lvl3Number": "961616161616",
"lvl4Number": "971717171717",
"lvl5Number": "981818181818",
"lvl6Number": "991919191919",
"lvl7Number": "893",
"uniqueId": 14223354
}, {
"hierarchyId": 90002352,
"merchantId": 14223354,
"hierarchyLevel": "100",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223358,
"lvl2Id": 222228,
"lvl3Id": ,
"lvl4Id": 444448,
"lvl5Id": 555558,
"lvl6Id": 666668,
"lvl7Id": 779,
"lvl1Number": "941414141414",
"lvl2Number": "951515151515",
"lvl3Number": "",
"lvl4Number": "971717171717",
"lvl5Number": "981818181818",
"lvl6Number": "991919191919",
"lvl7Number": "894",
"uniqueId": 14223354
}, {
"hierarchyId": 90002353,
"merchantId": 14223355,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T23:59:59.000Z",
"lvl1Id": 12223359,
"lvl2Id": 222229,
"lvl3Id": ,
"lvl4Id": 444449,
"lvl5Id": 555559,
"lvl6Id": 666669,
"lvl7Id": 780,
"lvl1Number": "041414141414",
"lvl2Number": "051515151515",
"lvl3Number": "",
"lvl4Number": "071717171717",
"lvl5Number": "081818181818",
"lvl6Number": "091919191919",
"lvl7Number": "895",
"uniqueId": 14223355
}, {
"hierarchyId": 90002354,
"merchantId": 14223356,
"hierarchyLevel": "120",
"dateFrom": "1000-01-01T00:00:00.000Z",
"dateTo": "9999-12-31T00:00:00.000Z",
"lvl1Id": 12223360,
"lvl2Id": 222220,
"lvl3Id": 333330,
"lvl4Id": 444440,
"lvl5Id": 555550,
"lvl6Id": 666660,
"lvl7Id": 781,
"lvl1Number": "141414141414",
"lvl2Number": "151515151515",
"lvl3Number": "161616161616",
"lvl4Number": "171717171717",
"lvl5Number": "181818181818",
"lvl6Number": "191919191919",
"lvl7Number": "896",
"uniqueId": 14223356
}],
"pagination": {
"rowCount": 10,
"pageCount": 1,
"countPerPage": 3000,
"page": 1
}
}
Service will retrieve the hierarchy item based on merchantlId and hierarchyLevel.
The appropriate field to search by merchantId from the "lvl1Id" to "lvl6Id" will be selected based on the hierarchyLevel. (refer to: hierarchyLevel Values).
Request
GET /api/manage/merchants/{merchantId}/hierarchies/{hierarchyLevel}
Optional query parameter: hierarchydate. i.e. GET /api/manage/merchants/{merchantId}/hierarchies/{hierarchyLevel}?hierarchydate=2019-04-18
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| hierarchyLevel | merchant hierarchy type as described in Hierarchy Definition. (refer to: hierarchyLevel Values). |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| hierarchyId | Unique identifier for the hierarchy. |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| dateFrom | Date when hierarchy became effective. |
| dateTo | date when hierarchy expired. |
| lvl1Id | Outlet level Merchant ID. |
| lvl2Id | Chain level Merchant ID. |
| lvl3Id | Lead Corporate level Merchant ID. |
| lvl4Id | Agent level Merchant ID. |
| lvl5Id | Bank level Merchant ID. |
| lvl6Id | Business Chain level Merchant ID. |
| lvl7Id | Bank marker. |
| lvl1Number | Outlet level MID. |
| lvl2Number | Chain level MID. |
| llvl3Number | Lead Corporate level MID. |
| lvl4Number | Agent level MID. |
| lvl5Number | Bank level MID. |
| lvl6Number | Business Chain level MID. |
| lvl7Number | Bank Marker ID. |
| uniqueId | The same as merchantId. |
GET Merchant Entitlement
# Don't forget to add your HMAC Authorization Headers
endpoint = "/merchants/779202/entitlements/823925161"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/merchants/779202/entitlements/823925161"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/merchants/779202/entitlements/823925161',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/merchants/779202/entitlements/823925161");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/merchants/779202/entitlements/823925161");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"result":{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":823925161,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"02",
"pricingPlanCode":"023",
"serviceTypeCode":"F",
"signedVolume":650000.0,
"avgTicket":150,
"alphaId":"",
"uniqueId":823925161
}
}
This service retrieves merchant’s entitlement.
Request
GET /api/manage/merchants/{merchantId}/entitlements/{entitlementId}
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| entitlementId | System generated ID of the entitlement |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| entitlementId | Unique identifier for the entitlement. |
| allianceCode | Alliance code associated with the marker. |
| platformCode | Indicates the platform that the MID uses for processing. (refer to: platformCode Values). |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| productCode | Identifies the type of entitlement associated with the merchant. (refer to: productCode Values). |
| pricingPlanCode | Identifies the best Interchange level at which the outlet’s has been priced. |
| serviceTypeCode | Identifies the type of service for the productCode. (refer to: serviceTypeCode Values). |
| signedVolume | Anticipated annual volume of transactions for the productCode. |
| avgTicket | Identifies the merchant’s average MasterCard, VISA, or Discover sales tickets without decimals for the relative product code. |
| alphaId | Identifier for the specific product type. Required for purchase Card to indicate demographics of merchant. |
productCode values
| Value | Meaning |
|---|---|
"01" | MASTERCARD |
"02" | VISA |
"03" | DISCOVER |
"04" | DINERS |
"05" | PRIVATE LABEL |
"06" | AMEX |
"07" | JCB |
"08" | AMEX OB |
"09" | (FUTURE) |
"10" | VOYAGER |
"11" | ENCORE |
"12" | (FUTURE) |
"13" | (FUTURE) |
"14" | (FUTURE) |
"15" | (FUTURE) |
"16" | (FUTURE) |
"17" | (FUTURE) |
"18" | DEBIT |
"19" | JBS |
"20" | TELECHECK |
"21" | TELECREDIT |
"22" | CHECK VERIFICATION(ETC) |
"23" | EXPLORE |
"24" | INTERLINK |
"25" | SWITCH |
"26" | PURCHASE CARD |
"27" | EBT |
"28" | DEBIT GATEWAY |
"29" | STORED VALUE FUNDED |
"30" | STORED VALUE UNFUNDED |
"31" | GENERIC PRIVATE LABEL |
"32" | TIER II CREDIT |
"33" | CHECK WARRANTEE |
"34" | CHECK NON-WARRANTEE |
"35" | WRIGHT EXPRESS |
"36" | FLEETCOR |
"37" | FLEETONE |
"38" | FUTURE PETROLEUM |
"39" | FUTURE PETROLEUM |
"40" | FUTURE PETROLEUM |
"46" | SEARS CARD |
"48" | Earn Loyalty |
"49" | BILL ME LATER |
"50" | Global Alt Mops |
"51" | PAYPAL |
"52" | Google Checkout |
"53" | Intl Alternative Payment |
"54" | Offerwise |
"56" | Signature Debit |
"75" | MAESTRO |
"78" | MAESTRO INTERNATIONAL |
UK Entitlement productCode values
| Value | Meaning |
|---|---|
"76" | V-pay |
"78" | Maestro International |
"79" | VISA |
"80" | VISA ELECTRON |
"81" | VISA DELTA |
"82" | VISA PURCHASING |
"83" | VISA DELTA CHIP |
"84" | VISA CHIP |
"85" | MASTERCARD |
"86" | MASTERCARD CHIP |
"87" | MASTERCARD PURCHASING |
"88" | MASTERCARD DEBIT |
"89" | DINERS |
"90" | JCB |
serviceTypeCode values
| Value | Meaning |
|---|---|
"A" | AUTH ONLY |
"D" | DEP + AUTH (CAPT) |
"F" | FULL SERVICE |
"I" | INFO ONLY - SPLIT DIAL |
"K" | DEPOSIT ONLY |
"M" | MEMO POST |
"N" | NO |
"R" | REVERSE PIP |
GET Merchant Entitlement List
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/779202/entitlements"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/779202/entitlements"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/779202/entitlements',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/779202/entitlements");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/779202/entitlements");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":823925161,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"02",
"pricingPlanCode":"023",
"serviceTypeCode":"F",
"signedVolume":650000.0,
"avgTicket":150,
"alphaId":"",
"uniqueId":823925161
},
{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":825996775,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"18",
"pricingPlanCode":"000",
"serviceTypeCode":"F",
"signedVolume":650000.0,
"avgTicket":150,
"alphaId":"",
"uniqueId":825996775
},
{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":828069361,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"03",
"pricingPlanCode":"010",
"serviceTypeCode":"F",
"signedVolume":14000.0,
"avgTicket":150,
"alphaId":"",
"uniqueId":828069361
},
{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":828605447,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"08",
"pricingPlanCode":"964",
"serviceTypeCode":"F",
"signedVolume":52500.0,
"avgTicket":150,
"alphaId":"NEW",
"uniqueId":828605447
},
{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":829143477,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"01",
"pricingPlanCode":"009",
"serviceTypeCode":"F",
"signedVolume":650000.0,
"avgTicket":150,
"alphaId":"",
"uniqueId":829143477
},
{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":831873085,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"07",
"pricingPlanCode":"000",
"serviceTypeCode":"F",
"signedVolume":0.0,
"avgTicket":0,
"alphaId":"",
"uniqueId":831873085
},
{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":832163875,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"26",
"pricingPlanCode":"000",
"serviceTypeCode":"A",
"signedVolume":650000.0,
"avgTicket":150,
"alphaId":"3000",
"uniqueId":832163875
},
{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"entitlementId":836108935,
"allianceCode":"TDB",
"platformCode":"FDN",
"merchantId":779202,
"productCode":"04",
"pricingPlanCode":"000",
"serviceTypeCode":"F",
"signedVolume":0.0,
"avgTicket":0,
"alphaId":"",
"uniqueId":836108935
}
],
"pagination":null
}
This service retrieves merchant’s entitlement list.
Request
GET /api/manage/merchants/{merchantId}/entitlements
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| entitlementId | Unique identifier for the entitlement. |
| allianceCode | Alliance code associated with the marker. |
| platformCode | Indicates the platform that the MID uses for processing. (refer to: platformCode Values). |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| productCode | Identifies the type of entitlement associated with the merchant. (refer to: productCode Values). |
| pricingPlanCode | Identifies the best Interchange level at which the outlet’s has been priced. |
| serviceTypeCode | Identifies the type of service for the productCode. (refer to: serviceTypeCode Values). |
| signedVolume | Anticipated annual volume of transactions for the productCode. |
| avgTicket | Identifies the merchant’s average MasterCard, VISA, or Discover sales tickets without decimals for the relative product code. |
| alphaId | Identifier for the specific product type. Required for purchase Card to indicate demographics of merchant. |
GET Merchant Fee
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/9579421/fees/1086255461"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/9579421/fees/1086255461"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/9579421/fees/1086255461',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/9579421/fees/1086255461");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/9579421/fees/1086255461");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"result":{
"feeId":1086255461,
"merchId":null,
"platformCode":null,
"sequenceCode":"03K",
"sequenceType":"F",
"name":"MC PIF FINAL AUTH MIN",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0400000",
"retailDate":"2017-05-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1086255461
}
}
This service retrieves merchant’s fee.
Request
GET /api/manage/merchants/{merchantId}/fees/{feeId}
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| feeId | System generated ID of the fee. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| feeId | Unique identifier for the fee. |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| platformCode | Indicates the platform that the MID uses for processing. (refer to: platformCode Values). |
| sequenceCode | Identifies the fee associated with the merchant account. |
| sequenceType | Identifies the type of sequenceCode. (refer to: sequenceType Values). |
| name | Description for the sequenceCode. |
| generalLedgerCode | General ledger code associated with the sequenceCode. |
| updateIndiator | |
| frequenceCode | Identifies the frequency with which the fee are applied. (refer to: frequenceCode Values). |
| retailRate | Retail dollar and cent amount charged for the sequenceCode. |
| retailDate | Effective date of the retailRate. |
| wholesaleRate | Retail dollar and cent amount charged for the sequenceCode. |
| wholesaleDate | Effective date of the wholesaleRate. |
| processingIndicator | Links the fee to specific merchant DDA. (refer to: processingIndicator Values). |
| globalNumber | Identifies the global fee table. |
| uniqueId | Unique identifier for the fee. |
platformCode values
| Value | Meaning |
|---|---|
"FDN" | North |
"FDE" | North (UK) |
"FDS" | South |
"FDM" | Memphis |
"OMA" | Omaha |
sequenceType values
| Value | Meaning |
|---|---|
"F" | FEE |
"A" | PRICING STRATEGY |
frequenceCode values
| Value | Meaning |
|---|---|
"D" | Daily |
"M" | Monthly |
"B" | Bi-Weekly |
"S" | Special |
"X" | Delayed-BillingretailRate |
processingIndicator values
| Value | Meaning |
|---|---|
"1-5" | Bill to the corresponding DDA 1-5 |
"B" | Bill (DDA1) |
"N" | No Billing |
"R" | Report Only Do Not Bill |
GET Merchant Fee List
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/9579421/fees"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/9579421/fees"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/9579421/fees',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/9579421/fees");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/9579421/fees");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"feeId":1086255461,
"merchId":null,
"platformCode":null,
"sequenceCode":"03K",
"sequenceType":"F",
"name":"MC PIF FINAL AUTH MIN",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0400000",
"retailDate":"2017-05-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1086255461
},
{
"feeId":1086604875,
"merchId":null,
"platformCode":null,
"sequenceCode":"24H",
"sequenceType":"F",
"name":"VI STAGED DIGITAL WALLET FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.1000000",
"retailDate":"2017-07-31T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-07-31T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1086604875
},
{
"feeId":1088265593,
"merchId":null,
"platformCode":null,
"sequenceCode":"606",
"sequenceType":"F",
"name":"US CROSS BORDER FEE, NONUSD",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0100000",
"retailDate":"2017-04-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1088265593
},
{
"feeId":1088295649,
"merchId":null,
"platformCode":null,
"sequenceCode":"804",
"sequenceType":"F",
"name":"VISA SALES DISCOUNT",
"generalLedgerCode":"40000",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"0.0260300",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1088295649
},
{
"feeId":1088378455,
"merchId":null,
"platformCode":null,
"sequenceCode":"850",
"sequenceType":"F",
"name":"MASTERCARD DEBIT SALES DISC",
"generalLedgerCode":"40000",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"0.0210300",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1088378455
},
{
"feeId":1088513863,
"merchId":null,
"platformCode":null,
"sequenceCode":"47N",
"sequenceType":"F",
"name":"VI BASE II SYSTEM FILE FEE",
"generalLedgerCode":"44002",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0018000",
"retailDate":"2016-04-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2016-04-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1088513863
},
{
"feeId":1089775471,
"merchId":null,
"platformCode":null,
"sequenceCode":"11P",
"sequenceType":"F",
"name":"SIG DEBIT AUTH FEE",
"generalLedgerCode":"44096",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.2000000",
"retailDate":"2017-05-24T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-24T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1089775471
},
{
"feeId":1089775473,
"merchId":null,
"platformCode":null,
"sequenceCode":"273",
"sequenceType":"F",
"name":"MASTERCARD ASSESSMENT FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2015-02-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2015-02-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1089775473
},
{
"feeId":1090086373,
"merchId":null,
"platformCode":null,
"sequenceCode":"854",
"sequenceType":"F",
"name":"VISA DEBIT SALES DISCOUNT",
"generalLedgerCode":"40000",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"0.0210300",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1090086373
},
{
"feeId":1090397345,
"merchId":null,
"platformCode":null,
"sequenceCode":"03I",
"sequenceType":"F",
"name":"MC PROC INTEG UNDEF AUTH",
"generalLedgerCode":"44001",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0450000",
"retailDate":"2017-05-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1090397345
},
{
"feeId":1090401283,
"merchId":null,
"platformCode":null,
"sequenceCode":"234",
"sequenceType":"F",
"name":"DISCOVER ASSESSMENT FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2015-02-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2015-02-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1090401283
},
{
"feeId":1090412289,
"merchId":null,
"platformCode":null,
"sequenceCode":"800",
"sequenceType":"F",
"name":"MASTERCARD SALES DISCOUNT",
"generalLedgerCode":"40000",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"0.0260300",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1090412289
},
{
"feeId":1091590381,
"merchId":null,
"platformCode":null,
"sequenceCode":"04K",
"sequenceType":"F",
"name":"STAR NETWORK INTEGRITY FEE",
"generalLedgerCode":"44096",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0500000",
"retailDate":"2017-05-24T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-24T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1091590381
},
{
"feeId":1091642949,
"merchId":null,
"platformCode":null,
"sequenceCode":"47O",
"sequenceType":"F",
"name":"VI BASE II CRVOUCHER FEE DB/PP",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0155000",
"retailDate":"2017-04-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1091642949
},
{
"feeId":1091785405,
"merchId":null,
"platformCode":null,
"sequenceCode":"22G",
"sequenceType":"F",
"name":"DISCVR INTL PROCESSING FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0050000",
"retailDate":"2016-06-27T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2016-06-27T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1091785405
},
{
"feeId":1091871445,
"merchId":null,
"platformCode":null,
"sequenceCode":"22H",
"sequenceType":"F",
"name":"DISCVR INTL SERVICE FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0080000",
"retailDate":"2016-06-27T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2016-06-27T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1091871445
},
{
"feeId":1091979903,
"merchId":null,
"platformCode":null,
"sequenceCode":"274",
"sequenceType":"F",
"name":"VISA ASSESSMENT FEE DB",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2015-02-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2015-02-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1091979903
},
{
"feeId":1092376381,
"merchId":null,
"platformCode":null,
"sequenceCode":"42G",
"sequenceType":"F",
"name":"NON RECEIPT OF PCI VALIDATION",
"generalLedgerCode":"47225",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"29.9500000",
"retailDate":"2018-07-25T00:00:00.000Z",
"wholesaleRate":29,
"wholesaleDate":"2018-07-25T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1092376381
},
{
"feeId":1092376383,
"merchId":null,
"platformCode":null,
"sequenceCode":"47P",
"sequenceType":"F",
"name":"VI BASE II CR VOUCHER FEE CR",
"generalLedgerCode":"44002",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0195000",
"retailDate":"2017-04-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1092376383
},
{
"feeId":1092413977,
"merchId":null,
"platformCode":null,
"sequenceCode":"24I",
"sequenceType":"F",
"name":"MC MONTHLY LOCATION FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"1.2500000",
"retailDate":"2017-04-27T00:00:00.000Z",
"wholesaleRate":1,
"wholesaleDate":"2017-04-27T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1092413977
},
{
"feeId":1092522477,
"merchId":null,
"platformCode":null,
"sequenceCode":"0BZ",
"sequenceType":"F",
"name":"STAR AUTH REQUEST FEE",
"generalLedgerCode":"42019",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0150000",
"retailDate":"2017-05-24T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-24T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1092522477
},
{
"feeId":1092735459,
"merchId":null,
"platformCode":null,
"sequenceCode":"0DD",
"sequenceType":"F",
"name":"PAYPAL NETWORK AUTH FEE",
"generalLedgerCode":"44014",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0185000",
"retailDate":"2017-07-31T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-07-31T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1092735459
},
{
"feeId":1092907441,
"merchId":null,
"platformCode":null,
"sequenceCode":"27L",
"sequenceType":"F",
"name":"VISA ASSESSMENT FEE CR",
"generalLedgerCode":"44002",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2015-02-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2015-02-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1092907441
},
{
"feeId":1092985825,
"merchId":null,
"platformCode":null,
"sequenceCode":"04G",
"sequenceType":"F",
"name":"VISA MISUSE OF AUTH FEE",
"generalLedgerCode":"42002",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0900000",
"retailDate":"2017-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-02-02T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1092985825
},
{
"feeId":1094003403,
"merchId":null,
"platformCode":null,
"sequenceCode":"27P",
"sequenceType":"F",
"name":"PINLESS SALES DISCOUNT",
"generalLedgerCode":"40000",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"0.0260300",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1094003403
},
{
"feeId":1094996627,
"merchId":null,
"platformCode":null,
"sequenceCode":"597",
"sequenceType":"F",
"name":"ADJUSTMENT FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2017-04-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1094996627
},
{
"feeId":1095321387,
"merchId":null,
"platformCode":null,
"sequenceCode":"22F",
"sequenceType":"F",
"name":"VS INTL ACQ FEE",
"generalLedgerCode":"44002",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0045000",
"retailDate":"2017-04-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1095321387
},
{
"feeId":1095703117,
"merchId":null,
"platformCode":null,
"sequenceCode":"493",
"sequenceType":"F",
"name":"DISCOVER FILED ARB FEE",
"generalLedgerCode":"47053",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"150.0000000",
"retailDate":"2017-04-30T00:00:00.000Z",
"wholesaleRate":150,
"wholesaleDate":"2017-04-30T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1095703117
},
{
"feeId":1095703119,
"merchId":null,
"platformCode":null,
"sequenceCode":"64T",
"sequenceType":"F",
"name":"STAR CLEARING TRANS FEE",
"generalLedgerCode":"44218",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2017-05-24T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-24T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1095703119
},
{
"feeId":1095824581,
"merchId":null,
"platformCode":null,
"sequenceCode":"22W",
"sequenceType":"F",
"name":"MC GLBL WHOLESALE TRAV B2B FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0157000",
"retailDate":"2017-04-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1095824581
},
{
"feeId":1096853003,
"merchId":null,
"platformCode":null,
"sequenceCode":"170",
"sequenceType":"F",
"name":"DISCOVER SALES DISCOUNT",
"generalLedgerCode":"44014",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"0.0260300",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1096853003
},
{
"feeId":1097399879,
"merchId":null,
"platformCode":null,
"sequenceCode":"03H",
"sequenceType":"F",
"name":"MC PROC INTEG PRE AUTH",
"generalLedgerCode":"42001",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0450000",
"retailDate":"2017-05-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1097399879
},
{
"feeId":1098122333,
"merchId":null,
"platformCode":null,
"sequenceCode":"340",
"sequenceType":"F",
"name":"MC BILLBACK AMOUNT",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"",
"retailRate":"0E-7",
"retailDate":"2012-10-13T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2012-10-13T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1098122333
},
{
"feeId":1098462983,
"merchId":null,
"platformCode":null,
"sequenceCode":"605",
"sequenceType":"F",
"name":"US CROSS BORDER FEE",
"generalLedgerCode":"44001",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0060000",
"retailDate":"2017-04-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1098462983
},
{
"feeId":1098662199,
"merchId":null,
"platformCode":null,
"sequenceCode":"22A",
"sequenceType":"F",
"name":"VISA INTL SERVICE FEE - BASE",
"generalLedgerCode":"44002",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0080000",
"retailDate":"2017-04-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1098662199
},
{
"feeId":1099297621,
"merchId":null,
"platformCode":null,
"sequenceCode":"587",
"sequenceType":"F",
"name":"DEBIT PRE AUTH",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2017-04-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099297621
},
{
"feeId":1099315779,
"merchId":null,
"platformCode":null,
"sequenceCode":"11M",
"sequenceType":"F",
"name":"MC CVC2 TRANSACTION FEE",
"generalLedgerCode":"44001",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0025000",
"retailDate":"2013-10-18T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2013-10-18T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099315779
},
{
"feeId":1099360007,
"merchId":null,
"platformCode":null,
"sequenceCode":"83A",
"sequenceType":"F",
"name":"SIG DEBIT SALES DISCOUNT",
"generalLedgerCode":"44218",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"0.0210300",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099360007
},
{
"feeId":1099418839,
"merchId":null,
"platformCode":null,
"sequenceCode":"22Z",
"sequenceType":"F",
"name":"VISA INTL SERVICE FEE - ENH",
"generalLedgerCode":"44002",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0120000",
"retailDate":"2015-04-18T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2015-04-18T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099418839
},
{
"feeId":1099488595,
"merchId":null,
"platformCode":null,
"sequenceCode":"341",
"sequenceType":"F",
"name":"VISA BILLBACK AMOUNT",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"",
"retailRate":"0E-7",
"retailDate":"2012-10-13T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2012-10-13T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099488595
},
{
"feeId":1099704859,
"merchId":null,
"platformCode":null,
"sequenceCode":"964",
"sequenceType":"F",
"name":"DISCOVER DEBIT SALES DISCOUNT",
"generalLedgerCode":"40000",
"updateIndicator":"C",
"frequenceCode":"M",
"retailRate":"0.0210300",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099704859
},
{
"feeId":1099763025,
"merchId":null,
"platformCode":null,
"sequenceCode":"03J",
"sequenceType":"F",
"name":"MC PROC INTEG FINAL AUTH",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0025000",
"retailDate":"2017-05-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099763025
},
{
"feeId":1099806571,
"merchId":null,
"platformCode":null,
"sequenceCode":"0B9",
"sequenceType":"F",
"name":"STAR AUTH REVERSAL FEE",
"generalLedgerCode":"44096",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0150000",
"retailDate":"2017-05-24T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-24T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099806571
},
{
"feeId":1099864903,
"merchId":null,
"platformCode":null,
"sequenceCode":"24E",
"sequenceType":"F",
"name":"DIGITAL ENABLEMENT FEE",
"generalLedgerCode":"44001",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0001000",
"retailDate":"2015-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2015-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099864903
},
{
"feeId":1099886813,
"merchId":null,
"platformCode":null,
"sequenceCode":"04I",
"sequenceType":"F",
"name":"VISA ZERO FLOOR LIMIT FEE",
"generalLedgerCode":"44002",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.2000000",
"retailDate":"2017-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-02-02T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099886813
},
{
"feeId":1099985205,
"merchId":null,
"platformCode":null,
"sequenceCode":"35K",
"sequenceType":"F",
"name":"SIG DEBIT BILLBACK",
"generalLedgerCode":"44096",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2017-05-24T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-24T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1099985205
},
{
"feeId":1100007233,
"merchId":null,
"platformCode":null,
"sequenceCode":"20B",
"sequenceType":"F",
"name":"DISCOVER BILLBACK AMOUNT",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"",
"retailRate":"0E-7",
"retailDate":"2012-10-13T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2012-10-13T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1100007233
},
{
"feeId":1102561403,
"merchId":null,
"platformCode":null,
"sequenceCode":"593",
"sequenceType":"F",
"name":"DEBIT DECLINE INTERCHANGE FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2017-04-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1102561403
},
{
"feeId":1102590949,
"merchId":null,
"platformCode":null,
"sequenceCode":"50F",
"sequenceType":"F",
"name":"SIG DEBIT ACCESS FEE",
"generalLedgerCode":"44218",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0340000",
"retailDate":"2017-05-24T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-05-24T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1102590949
},
{
"feeId":1104091331,
"merchId":null,
"platformCode":null,
"sequenceCode":"158",
"sequenceType":"F",
"name":"MONTHLY FUNDING ADVANTAGE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0003000",
"retailDate":"2018-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2018-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1104091331
},
{
"feeId":1104102277,
"merchId":null,
"platformCode":null,
"sequenceCode":"590",
"sequenceType":"F",
"name":"DEBIT INTERCHANGE FEE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2017-04-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1104102277
},
{
"feeId":1104269823,
"merchId":null,
"platformCode":null,
"sequenceCode":"10X",
"sequenceType":"F",
"name":"VISA ZERO AMT & AVS FEE",
"generalLedgerCode":"47011",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0250000",
"retailDate":"2017-04-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1104269823
},
{
"feeId":1104269825,
"merchId":null,
"platformCode":null,
"sequenceCode":"237",
"sequenceType":"F",
"name":"MC ASSESSMNT TRAN AMT >=$1K",
"generalLedgerCode":"47009",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0E-7",
"retailDate":"2015-02-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2015-02-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1104269825
},
{
"feeId":1104533395,
"merchId":null,
"platformCode":null,
"sequenceCode":"19E",
"sequenceType":"F",
"name":"PINLESS DEBIT AUTH FEE",
"generalLedgerCode":"42020",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.2000000",
"retailDate":"2015-03-18T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2015-03-18T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1104533395
},
{
"feeId":1104594907,
"merchId":null,
"platformCode":null,
"sequenceCode":"03E",
"sequenceType":"F",
"name":"SECURECODE TRANSACTION FEE",
"generalLedgerCode":"42001",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0300000",
"retailDate":"2017-04-28T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"2017-04-28T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1104594907
},
{
"feeId":1104649529,
"merchId":null,
"platformCode":null,
"sequenceCode":"401",
"sequenceType":"F",
"name":"ACH REJECT FEE",
"generalLedgerCode":"47037",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"29.5000000",
"retailDate":"2017-02-01T00:00:00.000Z",
"wholesaleRate":29,
"wholesaleDate":"2017-02-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1104649529
},
{
"feeId":1161684951,
"merchId":null,
"platformCode":null,
"sequenceCode":"48P",
"sequenceType":"F",
"name":"VI BASE II CRVCHER FEE INTL CR",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0395000",
"retailDate":"0001-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"0001-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1161684951
},
{
"feeId":1162210582,
"merchId":null,
"platformCode":null,
"sequenceCode":"48O",
"sequenceType":"F",
"name":"TEST DRIVE",
"generalLedgerCode":"40000",
"updateIndicator":"A",
"frequenceCode":"M",
"retailRate":"0.0355000",
"retailDate":"0001-01-01T00:00:00.000Z",
"wholesaleRate":0,
"wholesaleDate":"0001-01-01T00:00:00.000Z",
"processingIndicator":"1",
"globalNumber":"O",
"uniqueId":1162210582
}
],
"pagination":null
}
This service retrieves the list of merchant fees.
Request
GET /api/manage/merchants/{merchantId}/fees
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| feeId | Unique identifier for the fee. |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| platformCode | Indicates the platform that the MID uses for processing. (refer to: platformCode Values). |
| sequenceCode | Identifies the fee associated with the merchant account. |
| sequenceType | Identifies the type of sequenceCode. (refer to: sequenceType Values). |
| name | Description for the sequenceCode. |
| generalLedgerCode | General ledger code associated with the sequenceCode. |
| updateIndiator | |
| frequenceCode | Identifies the frequency with which the fee are applied. (refer to: frequenceCode Values). |
| retailRate | Retail dollar and cent amount charged for the sequenceCode. |
| retailDate | Effective date of the retailRate. |
| wholesaleRate | Retail dollar and cent amount charged for the sequenceCode. |
| wholesaleDate | Effective date of the wholesaleRate. |
| processingIndicator | Links the fee to specific merchant DDA. (refer to: processingIndicator Values). |
| globalNumber | Identifies the global fee table. |
| uniqueId | Unique identifier for the fee. |
GET Merchant Processing Platform
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/platforms"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/platforms"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/platforms',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/platforms");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/platforms");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"merchantId":987654321,
"accountSourceIndicator":"",
"accountStatus":"16",
"authLimit":0,
"creditLimit":0,
"rppDelayDays":0,
"salesLimit":0,
"uniqueId":987654321
}
],
"pagination":null
}
This service retrieves the processing platform list for the merchant.
Request
GET /api/manage/merchants/{merchantId}/platforms
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| accountSourceIndicator | Represents the platform where the merchants are boarded. (refer to: accountSourceIndicator Values). |
| accountStatus | Indicates the account status of the merchant account. (refer to: accountStatus Values). |
| rppDelayDays | Revolving Payment Plan delay days. This field will delay the releasing of merchant’s funds for the number of days specified. |
| authLimit | Maximum amount of authorization for merchant lite accounts. |
| creditLimit | Maximum credit amount for merchant lite accounts. |
| salesLimit | Maximum sales amount for merchant lite accounts. |
accountSourceIndicator values
| Value | Meaning |
|---|---|
"2" | AMA Click to Agree |
"A" | AMA |
"B" | BAM (Batch) |
"C" | Converted Account |
"D" | AMA DE |
"E" | VAPP Brick & Mortar |
"G" | GSB Boarding |
"H" | Hierarchy Add |
"I" | VAPP Internet |
"L" | SNAP Merchant Lite |
"M" | Mercury |
"R" | AccessOne |
"S" | FD SNAP |
"T" | Traces |
"U" | AMA UAL |
"W" | AMA Web |
"Z" | eCommerce |
"7" | Partner Referral |
accountStatus values
| Value | Meaning |
|---|---|
"01" | Pending Status – Pending Credit Decision |
"02" | Fraud Merchant – Canceled By Security/Fraud |
"03" | MAI Decline – Declined Credit Decision |
"11" | Active Settles Weekly on a Friday |
"13" | Cancellation – General Cancellation |
"14" | Active Settles last Friday of the month |
"15" | Active Direct Payment Plan |
"16" | End of Calendar Month |
GET Merchant Program by ID
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/programs/8111111"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/programs/8111111"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/programs/8111111',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/programs/8111111");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/programs/8111111");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"result":{
"recLoad":null,
"recUpdate":null,
"recDelete":null,
"merchantProgramId":8111111,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5005",
"fieldId":"-1",
"dataValue":"",
"uniqueId":8111111
}
}
Retrieves information about a specific merchant program.
Sample values:
| Code | Name | Notes |
|---|---|---|
5012 | Payeezy | Boarding and maintenance program. |
5013 | CROSS BORDER ACQUIRING | Boarding and maintenance program. |
5014 | MASTER PASS WALLET | Channel-specific boarding and maintenance program for only Marker Bank 411/421/422. |
Request
GET /api/manage/merchants/{merchantId}/programs/{programId}
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| programId | Identifying the program that needs to be setup for the merchant. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| merchantProgramId | Uniquely identifies the programCode, fieldId, dataValue for the merchant. |
| allianceCode | Alliance code associated with the marker. |
| platformCode | Processing platform identification code. (refer to: platformCode Values). |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| programCode | Code identifying a program associated with the merchant. (refer to: Valid combinations of programCode, fieldId and dataValue). |
| fieldId | Identifies the option selected for the programCode. (refer to: Valid combinations of programCode, fieldId and dataValue). |
| dataValue | Identifies the option selected for the fieldId. (refer to: Valid combinations of programCode, fieldId and dataValue). |
| recLoad | Date the program was created. |
| recUpdate | Date the program was updated. |
| recDelete | Date the program was deleted. |
| uniqueId | merchantProgramId. |
Valid combinations of programCode, fieldId and dataValue.
programCode | Program Description | fieldId | dataValue |
|---|---|---|---|
| 5003 | Insightics (SMB Analytics) | 0001 - DATA_RIGHTS_USAGE | 1 - Opted-out |
| 5003 | Insightics (SMB Analytics) | 0002 - PRODUCT TYPE | 01-CLOVER INSIGHTS |
| 5003 | Insightics (SMB Analytics) | 0002 - PRODUCT TYPE | 02- CLOVER INSIGHTS EXP |
| 5003 | Insightics (SMB Analytics) | 0002 - PRODUCT TYPE | 03- CLOVER INSIGHTS APP |
| 5003 | Insightics (SMB Analytics) | 0003 - PRIMARY EMAIL INDICATOR | N-USE USER PROVIDED INSIGHTIC EMAIL |
| 5003 | Insightics (SMB Analytics) | 0003 - PRIMARY EMAIL INDICATOR | Y-USE PRIMARY EMAIL |
| 5003 | Insightics (SMB Analytics) | 0004 - USER PROVIDED INSIGHTIC EMAIL | email address |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | C-CANCELLED BY FD |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 1-SUBSCRIBED |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 2-UNSUBSCRIBED |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 3-PENDING UNCONTACTED |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 4-PENDING CONTACTED |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 5-PENDING UPGRADE |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 6-NO RESPONSE |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 7-FREE TRIAL |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 8-ACTIVE |
| 5003 | Insightics (SMB Analytics) | 1001 - STATUS | 9-CANCELED BY MERCHANT |
| 5003 | Insightics (SMB Analytics) | 1006 – BILLING EFFECTIVE DATE | Billing Effective Date |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 01 – FULL BUNDLE |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 02 - Clover + Full Bundle |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 03 - Bundle w/o Data Protection |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 04 - Compliance Tool Only |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 05 - COMPLIANCE TOOL + LW |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 06 - CLOVER W/DP+COMPLIANC |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 07 - COMPLIANCE TOOL + DP |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 09 - Merchant opted out |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 10 - BUNDLE W/O HW MONITOR |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 11 - BUNDLE W/O HW, SW MON |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 12 - DATA PROTECT W/ AMF |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 13 - DATA PROTECTION ONLY |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 15 - DATA PRTCT FOR CLOVER |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 11 - TA Essentials for Non-Clover |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 12 - TA Essentials for Clover |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 11 - Level 3 Full Bundle |
| 5005 | Cyber Security Program | 0001-PRODUCT TYPE | 12 - Level 3 Bundle without TransArmor/Data Protection |
| 5005 | Cyber Security Program | 1006 – BILLING EFFECTIVE DATE | Billing Effective Date |
| 5009 | Clover | 0001 – CLOVER ACCOUNT STATUS | “A-ACTIVE C-CANCEL” |
| 5009 | Clover | 0002 – CLOVER ID | ID identifying clover device |
| 5009 | Clover | 0003 – CLOVER DEVICES COUNT | Number of clover devices |
| 5009 | Clover | 0004 – WELLS CLOVER CONFIG ID | Unique ID for Wells Clover |
| 5009 | Clover | 1002 – OFFERING TYPE | 01 - Payments Plus |
| 5009 | Clover | 1002 – OFFERING TYPE | 02 – Register |
| 5009 | Clover | 1002 – OFFERING TYPE | 03 - Register Lite |
| 5009 | Clover | 1002 – OFFERING TYPE | (Boarding & Maintenance Only) |
| 5009 | Clover | 0004 – Clover Unique ID | Unique Clover ID |
| 5012 | Payeezy | 1001-STATUS | “A-ACTIVE C-CANCEL” |
| 5012 | Payeezy | 1002- OFFERING TYPE | 01 – STANDARD OFFERING |
| 5012 | Payeezy | 0001-REFERRAL CODE | PAA0F0 for webstore |
| 5012 | Payeezy | 0002 – CLOVER ONLINE STORE STORE | 01-CLOVER ONLINE STORE |
| 5012 | Payeezy | 1006-BILLING EFFECTIVE DATE | Billing Effective Date |
| 5017 | Clover Go | 1001 – STATUS | “A-ACTIVE C-CANCEL” |
| 5017 | Clover Go | 1002- Offering Type | 01-AUTHORIZATION DATA |
| 5017 | Clover Go | 1002- Offering Type | 02-SETTLEMENT DATA |
| 5017 | Clover Go | 1002- Offering Type | 03-AUTH AND SETTLEMENT" |
GET Merchant Programs
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/programs"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/programs"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/programs',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/programs");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/programs");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"merchantProgramId":8111111,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5003",
"fieldId":"-1",
"dataValue":"",
"uniqueId":8111111
},
{
"merchantProgramId":81111112,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5003",
"fieldId":"0002",
"dataValue":"02",
"uniqueId":81111112
},
{
"merchantProgramId":8111113,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5005",
"fieldId":"-1",
"dataValue":"",
"uniqueId":81111113
},
{
"merchantProgramId":81111114,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5005",
"fieldId":"0001",
"dataValue":"11",
"uniqueId":81111114
},
{
"merchantProgramId":81111115,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5005",
"fieldId":"1006",
"dataValue":"10/01/2014",
"uniqueId":81111115
},
{
"merchantProgramId":81111116,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5019",
"fieldId":"-1",
"dataValue":"",
"uniqueId":81111116
},
{
"merchantProgramId":81111117,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5019",
"fieldId":"0003",
"dataValue":"N",
"uniqueId":81111117
},
{
"merchantProgramId":81111118,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5042",
"fieldId":"-1",
"dataValue":"",
"uniqueId":81111118
},
{
"merchantProgramId":81111119,
"allianceCode":"XYZ",
"platformCode":"FDN",
"merchantId":987654321,
"programCode":"5042",
"fieldId":"0001",
"dataValue":"",
"uniqueId":81111119
}
]
}
Retrieves the list and information of merchant programs.
Request
GET /api/manage/merchants/{merchantId}/programs
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| merchantProgramId | Uniquely identifies the programCode, fieldId, dataValue for the merchant. |
| allianceCode | Alliance code associated with the marker. |
| platformCode | Processing platform identification code. (refer to: platformCode Values). |
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| programCode | Code identifying a program associated with the merchant. (refer to: Valid combinations of programCode, fieldId and dataValue). |
| fieldId | Identifies the option selected for the programCode. (refer to: Valid combinations of programCode, fieldId and dataValue). |
| dataValue | Identifies the option selected for the fieldId. (refer to: Valid combinations of programCode, fieldId and dataValue). |
| uniqueId | merchantProgramId. |
GET Merchant Statement Delivery Information
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/820963/statementdeliveryinformations"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/820963/statementdeliveryinformations"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/820963/statementdeliveryinformations',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/820963/statementdeliveryinformations");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/820963/statementdeliveryinformations");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"merchantId":820963,
"recapCode":"02",
"statementDeliveryMethod":"E",
"statementType":"C",
"uniqueId":820963
}
],
"pagination":null
}
Service will retrieve the List of statements.
Request
GET /api/manage/merchants/{merchantId}/statementdeliveryinformations
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| recapCode | Identifies whether statements are sent to each outlet, or recap to the corporate chain location. (refer to: recapCode Values). |
| statementDeliveryMethod | Statement delivery method. (refer to: statementDeliveryMethod Values). |
| statementType | Statement Type. (refer to: statementType Values). |
| uniqueId | Unique identifier that is generated by Business Track and associated with the MID. |
recapCode values
| Value | Meaning |
|---|---|
"07" | No statement is mailed. (Loaded to online). |
"01" | Statement is in its own package getting mail to DBA (only meant for outlets). |
"02" | Statement is in its own package getting mail to BTA (only meant for outlets). |
"08" | Recap statement is only sent to Chains BTA all the chain outlets should be set up with 08, which will not go anywhere. |
"09" | Outlets and recap statements get mailed to Chains BTA in one package. |
"10" | Outlets in their own package sent to outlet BTA and recap mailed to Chains BTA. |
"30" | Outlets go to their DBA and recap is mailed to chains BTA. |
statementDeliveryMethod values
| Value | Meaning |
|---|---|
"B" | Bulk Mail. |
"H" | Hold. |
"P" | Mail. |
"E" | Email. |
statementType values
| Value | Meaning |
|---|---|
"C" | Concord Detail. |
"D" | Concord Summary. |
"F" | FDCS Detail. |
"G" | FDCS Summary. |
"P" | For the participating Alliance only. |
"B" | Chain Summary (For participating alliance only). |
GET Statement Dates
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/statementDates?statementType=Location&dateFrom=2017-01-01&dateTo=2019-05-29"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/statementDates?statementType=Location&dateFrom=2017-01-01&dateTo=2019-05-29"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/statementDates?statementType=Location&dateFrom=2017-01-01&dateTo=2019-05-29',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/statementDates?statementType=Location&dateFrom=2017-01-01&dateTo=2019-05-29");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/statementDates?statementType=Location&dateFrom=2017-01-01&dateTo=2019-05-29");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"result":{
"statementRespMap":{
"2017":[
{
"date":"2017-12-31",
"key":"NOM180101151773T002_1_1200715947",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2017-11-30",
"key":"NOM171202085773T002_1_575507718",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2017-10-31",
"key":"NOM171104165873T001_1_1416151306",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2017-09-30",
"key":"NOM171007154176T001_1_2138132110",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2017-08-31",
"key":"15043012179421524101752130335420",
"statementType":"Location_Detail",
"length":"246070"
},
{
"date":"2017-07-31",
"key":"15016236696101524101756130339213",
"statementType":"Location_Detail",
"length":"121094"
}
],
"2018":[
{
"date":"2018-12-31",
"key":"NOM190101110574T002_1_140682966",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-11-30",
"key":"NOM181203101873T002_1_2004266285",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-10-31",
"key":"NOM181101145273T002_1_79459294",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-09-30",
"key":"NOM181001131273T002_1_1078150688",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-08-31",
"key":"NOM180901155273T002_1_213976121",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-07-31",
"key":"NOM180803205075T002_1_898050069",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-06-30",
"key":"NOM180702151273T002_1_1548647812",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-05-31",
"key":"NOM180604150573T002_1_1178134538",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-04-30",
"key":"NOM180502015273T002_1_1306830772",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-03-31",
"key":"NOM180403122874T002_1_478624876",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-02-28",
"key":"NOM180301165973T002_1_2133484424",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2018-01-31",
"key":"NOM180201141573T002_1_194217972",
"statementType":"LOCATION",
"length":"0"
}
],
"2019":[
{
"date":"2019-04-30",
"key":"NOM190502025373T002_1_554279134",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2019-03-31",
"key":"NOM190401110975T002_1_749307593",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2019-02-28",
"key":"NOM190301140473T002_1_242910165",
"statementType":"LOCATION",
"length":"0"
},
{
"date":"2019-01-31",
"key":"NOM190201151473T002_1_267942227",
"statementType":"LOCATION",
"length":"0"
}
]
}
}
}
This service will retrieve merchant statement dates based off date range.
Request
GET /api/manage/merchants/{merchantId}/statementDates?statementType={statementType}&dateFrom={dateFrom}&dateTo={dateTo}
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| dateFrom | Statements in the period starting at. Use yyyy-mm-dd format i.e. 2012-05-29. |
| dateTo | Statements in the period ending at. Use yyyy-mm-dd format i.e. 2019-05-29. |
| statementType | Identifies the type of detail provided on the statement. (refer to: statementType Values). |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| “year” (####) | Year for which the data is reported |
| date | Month and year for which the statement was produced. |
| key | Unique, system-generated identifier used to identify each statement. |
| statementType | Identifies the type of detail provided on the statement. (refer to: statementType Values). |
| length | Statement length. |
statementType values
| Value | Meaning |
|---|---|
| Location | Location detail is available on the statement. |
| Location Detail | Location detail is available on the statement. |
| Location Summary | Location summary data is available on the statement. |
| Recap Detail | Recap detail is provided on the statement. |
| Recap Summary | Recap summary data is provided on the statement. |
| BAMS Chain Summary | Alliance specific for a chain summary statement. |
GET Statement Types
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/statementtypes"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/statementtypes"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/statementtypes',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/statementtypes");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/statementtypes");
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:
Success response
{
"errorDetails": null,
"message": null,
"responseCode": "success",
"reasonCode": "success",
"results": [
{
"statementTypeKey": "Location",
"statementTypeValue": "Location"
},
{
"statementTypeKey": "Corporate",
"statementTypeValue": "Recap"
}
],
"pagination": {
"rowCount": 2,
"pageCount": 1,
"countPerPage": 5,
"page": 1
}
}
This service will retrieve statement types based off merchant.
It will return LOCATION as the default statement type and CORPORATE if the merchant’s hierarchy level is higher that LOCATION and the number of sub merchants is more than 1. For definition of hierarchy types see: hierarchyLevelAbbreviation Values.
Request
GET /api/manage/merchants/{merchantId}/statementtypes
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| statementTypeKey | Identifies the whether the merchant is a 120 level Location merchant or not. |
| statementTypeValue | identifies whether the statement shows details for the 120 (Location) level merchant or summary information for other merchant levels. |
statementTypeKey values
| Value | Meaning |
|---|---|
"Location" | 120 (Location) level merchant. |
"Corporate" | Not a 120 (Location) level merchant. |
statementTypeValue values
| Value | Meaning |
|---|---|
"Location" | Statement details for the 120 (Location) level merchant. |
"Recap" | Statement recap information for the merchant. |
GET Statement Delivery Type
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/statementdeliverytype"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/statementdeliverytype"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/statementdeliverytype',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/statementdeliverytype");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/statementdeliverytype");
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:
Success response
{
"errorDetails": null,
"message": null,
"responseCode": "success",
"reasonCode": "success",
"result": {
"type": "POSTED"
}
}
Service returns merchant statement delivery type ("Posted" or "Funded").
Request
GET /api/manage/merchants/{merchantId}/statementdeliverytype
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
This endpoint returns a string, representing the statement delivery type.
| Parameter | Description |
|---|---|
| type | Indicates whether the merchant receives Posted or Funded statements. (refer to: Statement Delivery Type Values). |
Statement deliverytype values
| Value | Meaning |
|---|---|
"POSTED" | Merchant receives a statement based on when their activity (sales and fees) were posted. |
"FUNDED" | Merchant receives a statement based on when their activity (sales and fees) were funded. |
GET Merchant ID/Highlights Date Ranges
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/820963/highlightsdateranges"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/820963/highlightsdateranges"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/820963/highlightsdateranges',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/820963/highlightsdateranges");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/820963/highlightsdateranges");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"result":{
"fromDate":[
"2019-04-01",
"2019-03-01",
"2019-02-01",
"2019-01-01",
"2018-12-01",
"2018-11-01",
"2018-10-01",
"2018-09-01",
"2018-08-01",
"2018-07-01",
"2018-06-01",
"2018-05-01",
"2018-04-01",
"2018-03-01",
"2018-02-01",
"2018-01-01",
"2017-12-01",
"2017-11-01",
"2017-10-01",
"2017-09-01",
"2017-08-01",
"2017-07-01",
"2017-06-01",
"2017-05-01",
"2017-04-01"
],
"toDate":[
"2019-04-30",
"2019-03-31",
"2019-02-28",
"2019-01-31",
"2018-12-31",
"2018-11-30",
"2018-10-31",
"2018-09-30",
"2018-08-31",
"2018-07-31",
"2018-06-30",
"2018-05-31",
"2018-04-30",
"2018-03-31",
"2018-02-28",
"2018-01-31",
"2017-12-31",
"2017-11-30",
"2017-10-31",
"2017-09-30",
"2017-08-31",
"2017-07-31",
"2017-06-30",
"2017-05-31",
"2017-04-30"
]
}
}
This service will retrieve statement highlights date ranges based off merchant.
Request
GET /api/manage/merchants/{merchantId}/highlightsdateranges
| Parameter | Description |
|---|---|
| merchantId | System generated Merchant ID. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Data Type | Description |
|---|---|---|
| fromDate | array | List of Statement Highlights Starting Dates. |
| toDate | array | List of Statement Hightlights End Dates. |
GET Merchant Disputes
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/25998189/disputes"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/25998189/disputes"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/25998189/disputes',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/25998189/disputes");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/25998189/disputes");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"result":{
"chargeBackCount":6620,
"retrievalCount":2,
"chargeBackAmount":"$ 91,313.71",
"retrievalAmount":"$ 27.09",
"disputesTotalCount":6622
}
}
This service will retrieve currently open cardholder dispute case totals for the respective merchant(s).
Request
GET /api/manage/merchants/{merchantId}/disputes
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| chargeBackCount | Number of open chargebacks assigned to this merchant. |
| retrievalCount | Number of open retrievals assigned to this merchant. |
| chargeBackAmount | Monetary amount of open chargebacks assigned to this merchant. |
| retrievalAmount | Monetary amount of open retrievals assigned to this merchant. |
| disputesTotalCount | Total number of open chargebacks and retrievals assigned to this merchant. |
GET Merchant Statement by Statement Key
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/31721677/statementdocuments/15043012179421524101752130335420"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/31721677/statementdocuments/15043012179421524101752130335420"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/31721677/statementdocuments/15043012179421524101752130335420',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/31721677/statementdocuments/15043012179421524101752130335420");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/31721677/statementdocuments/15043012179421524101752130335420");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$res = curl_exec($ch);
echo($res);
?>
The above command returns a PDF stream as a response.
This service will retrieve the actual merchant statement in pdf.
Request
GET /api/manage/merchants/{merchantId}/statementdocuments/{statementKey}
| Parameter | Description |
|---|---|
| merchantId | System generated Merchant ID. |
| statementKey |
Response
This endpoint returns a PDF stream as a response.
GET 1099k Forms
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/9579421/1099kforms?taxYear=2017"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/9579421/1099kforms?taxYear=2017"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/9579421/1099kforms?taxYear=2017',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/9579421/1099kforms?taxYear=2017");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/9579421/1099kforms?taxYear=2017");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"formId":"20371411",
"customerId":"6818027",
"payerId":"40089",
"payerName":"THE REPORTING SERVICES LLC",
"payerAddress1":"987 MAIN STREET",
"payerAddress2":"",
"payerCity":"ANYTOWN",
"payerZip":"123459876",
"taxYear":2017
}
],
"pagination":{
"rowCount":1,
"pageCount":1,
"countPerPage":200,
"page":1
}
}
This service retrieves 1099K forms based off Tax year. This service supports last 2 years only.
Request
GET /api/manage/merchants/{merchantId}/1099kforms?taxYear={taxYear}&countPerPage={countPerPage}&page={page}
| Parameter | Required | Description |
|---|---|---|
| merchantId | ✔ | System generated Merchant ID. |
| taxYear | Year within last 2 years. Defaults to last 2 years if not set. | |
| countPerPage | Max count expected for a page. | |
| page | Page Number. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| formId | Year for which the form 1099-K data is reported. |
| customerId | Unique tax system identifier for the payee. |
| payerId | Unique tax system identifier for the form 1099-K payer. |
| payerName | Name of the payer on the form 1099-K. |
| payerAddress1 | Address line 1 of the payer on the form 1099-K. |
| payerAddress2 | Address line 2 of the payer on the form 1099-K. |
| payerCity | City of the payer on the form 1099-K. |
| payerZip | Zip code of the payer on the form 1099-K. |
| taxYear | Year for which the tax data is reported. |
GET 1099k Forms by Form ID
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/9579421/1099kforms/20371411"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/9579421/1099kforms/20371411"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/9579421/1099kforms/20371411',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/9579421/1099kforms/20371411");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/9579421/1099kforms/20371411");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$res = curl_exec($ch);
echo($res);
?>
The above command returns a PDF stream as a response.
This service retrieves 1099K form based off form ID and type (summary or detail).
Request
GET /api/manage/merchants/{merchantId}/1099kforms/{formId}?formType={formType}
| Parameter | Description |
|---|---|
| merchantId | System generated Merchant ID. |
| formId | |
| formType | Summary or Detail. Defaults to Summary. |
Response
The response for this API is the PDF Stream of the formID and type of form requested (summary or detail).
GET Merchant Tax Information Summary By Year
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/16733841/90/taxinformations/2019/summary"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/16733841/90/taxinformations/2019/summary"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/16733841/90/taxinformations/2019/summary',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/16733841/90/taxinformations/2019/summary");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/16733841/90/taxinformations/2019/summary");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"result":{
"validTINCount":2,
"inValidTINCount":1,
"taxFilingNamesInUse":3,
"grossReportableSalesTotal":"$ 1,545,854,295.38",
"federalAmountTotal":"$ 0.00",
"stateAmountTotal":"$ 0.00",
"taxYear":2019
}
}
This service retrieves the tax summary information of a merchant for respective year.
Request
GET /api/manage/merchants/{merchantId}/{hierarchylevel}/taxinformations/{year}/summary
| Parameter | Required | Description |
|---|---|---|
| merchantId | ✔ | System generated Merchant ID. |
| hierarchylevel | ✔ | Refer to: hierarchyLevel Values. |
| year | ✔ | Selected calendar year i.e. 2019. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| validTINCount | Number of valid TINs associated with this MID. |
| inValidTINCount | Number of invalid TINs associated with this MID. |
| taxFilingNamesInUse | Number of names identified as tax filing names associated with this MID. |
| grossReportableSalesTotal | Total amount of sales for the taxYear. |
| federalAmountTotal | Total federal backup withholding amount. |
| stateAmountTotal | Total state backup withholding amount. |
| taxYear | Year for which the tax data is reported. |
GET Merchant Tax Information By Year
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/16733841/90/taxinformations/2019?taxStatus=valid&countPerPage=5&page=1"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/16733841/90/taxinformations/2019?taxStatus=valid&countPerPage=5&page=1"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/16733841/90/taxinformations/2019?taxStatus=valid&countPerPage=5&page=1',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/16733841/90/taxinformations/2019?taxStatus=valid&countPerPage=5&page=1");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/16733841/90/taxinformations/2019?taxStatus=valid&countPerPage=5&page=1");
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:
Success response
{
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"taxIdentificationNumber":"XXXXX1234",
"taxFilingName":"ANY TAX NAME LLC",
"grossReportableSales":"$ 1,538,382,361.34",
"federalAmount":"$ 0.00",
"stateAmount":"$ 0.00",
"taxYear":2019,
"taxStatus":"VALID",
"backupWithHolding":true
},
{
"taxIdentificationNumber":"XXXXX4321",
"taxFilingName":"STORECOM",
"grossReportableSales":"$ 7,471,934.04",
"federalAmount":"$ 0.00",
"stateAmount":"$ 0.00",
"taxYear":2019,
"taxStatus":"VALID",
"backupWithHolding":true
}
],
"pagination":{
"rowCount":2,
"pageCount":1,
"countPerPage":5,
"page":1
}
}
This service retrieves the tax information of a merchant for respective year.
Request
GET /api/manage/merchants/{merchantId}/{hierarchylevel}/taxinformations/{year}?taxStatus={taxStatus}&countPerPage={countPerPage}&page={page}
| Parameter | Required | Description |
|---|---|---|
| merchantId | ✔ | System generated Merchant ID. |
| hierarchylevel | ✔ | Refer to: hierarchyLevel Values. |
| year | ✔ | Selected calendar year i.e. 2019. |
| taxStatus | valid or invalid. Default to all statuses if not set. | |
| countPerPage | Max count expected for a page. | |
| page | Page Number. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| taxIdentificationNumber | Merchant’s Tax Identification Number (TIN). |
| taxFilingName | Name under which this merchant files taxes. |
| grossReportableSales | Total amount of gross reportable sales for the taxYear. |
| federalAmount | Total amount of federal backup withholding. |
| stateAmount | Total amount of state backup withholding. |
| backupWithHolding | Backup withholding (refer to: backupWithHolding Values). |
| taxYear | Year for which the tax data is reported. |
| taxStatus | Tax Status (refer to: taxStatus Values). |
taxStatus values
| Value | Meaning |
|---|---|
"VALID" | The taxIdentificationNumber is valid. |
"INVALID" | The taxIdentificationNumber is not valid. |
backupWithHolding values
| Value | Meaning |
|---|---|
true | The merchant is on backup withholding. |
false | The merchant is not on backup withholding. |
POST Merchant Tax Information Location
# Don't forget to add your HMAC Authorization Headers
data = {
"taxIdentificationNumber":"XXXXX8166"
}
endpoint = "/api/manage/merchants/987654322/100/taxinformations/2018/locations?taxStatus=valid&countPerPage=5&page=1"
r = requests.post(url + endpoint, json=data, headers=headers)
print(r.text)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654322/100/taxinformations/2018/locations?taxStatus=valid&countPerPage=5&page=1"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
"taxIdentificationNumber":"XXXXX8166"
}' $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = { method: 'POST',
url: url + '/api/manage/merchants/987654322/100/taxinformations/2018/locations?taxStatus=valid&countPerPage=5&page=1',
headers: getAuthenticationHeaders(),
body:
{
"taxIdentificationNumber":"XXXXX8166"
},
json: true };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
// Don't forget to add your HMAC Authorization Headers
try {
String jsonString = "{\n" +
" \"taxIdentificationNumber\": \"XXXXX8166\"\n" +
"}";
StringEntity payload = new StringEntity(jsonString);
HttpResponse response = doPost("/api/manage/merchants/987654322/100/taxinformations/2018/locations?taxStatus=valid&countPerPage=5&page=1", payload);
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$data = array (
'taxIdentificationNumber' => 'XXXXX8166',
);
$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 . "/api/manage/merchants/987654322/100/taxinformations/2018/locations?taxStatus=valid&countPerPage=5&page=1");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"locationId":"341414141414",
"locationDBAName":"BLUE STORE"
}
],
"pagination":{
"rowCount":1,
"pageCount":1,
"countPerPage":6,
"page":1
}
}
This service retrieves the location information for respective Tax Identification Number.
Request
POST /api/manage//merchants/{merchantId}/{hierarchylevel}/taxinformations/{year}/locations?taxStatus={taxStatus}&countPerPage={countPerPage}&page={page}
| Parameter | Required | Description |
|---|---|---|
| merchantId | ✔ | System generated Merchant ID. |
| hierarchylevel | ✔ | Refer to: hierarchyLevel Values. |
| year | ✔ | Selected calendar year i.e. 2019. |
| taxIdentificationNumber | ✔ | Tax Identification Number (TIN). |
| taxStatus | valid or invalid. Default to all statuses if not set. | |
| countPerPage | Max count expected for a page. | |
| page | Page Number. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| locationId | Unique identifier for the location associated with the Tax Identification Number. |
| locationDBAName | “Doing Business As” (DBA) name for the Location ID. |
GET Merchant Orders By Date
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/orders?dateFrom=2018-01-01&dateTo=2018-02-02"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/orders?dateFrom=2018-01-01&dateTo=2018-02-02"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/orders?dateFrom=2018-01-01&dateTo=2018-02-02',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/orders?dateFrom=2018-01-01&dateTo=2018-02-02");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/orders?dateFrom=2018-01-01&dateTo=2018-02-02");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"results":[
{
"orderNumber":"900000012345678",
"orderDate":"2018-01-29"
},
{
"orderNumber":"900000023456789",
"orderDate":"2018-01-24"
}
],
"pagination":{
"rowCount":2,
"pageCount":1,
"countPerPage":200,
"page":1
}
}
This service retrieves the order information of a merchant order for respective date.
Request
GET /api/manage/merchants/{merchantId}/orders?dateFrom={dateFrom}&dateTo={dateTo}
| Parameter | Description |
|---|---|
| merchantId | System generated Merchant ID. |
| dateFrom | |
| dateTo |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| orderNumber | Unique order number that identifies the order in the TASQ system. |
| orderDate | Date on which the order was placed. |
GET Merchant Orders By Order Number
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/merchants/987654321/orders/100000021841386"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/merchants/987654321/orders/100000021841386"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/merchants/987654321/orders/100000021841386',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/merchants/987654321/orders/100000021841386");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/merchants/987654321/orders/100000021841386");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"result":{
"orderNumber":"900000012345678",
"orderDate":"2018-01-29",
"shipDate":null,
"shipMethod":"13",
"shipMethodDescription":"3 DAY SERVICE",
"trackingDetails":null,
"trackingNumber":null,
"carrier":null,
"ecollateral":"Y",
"merchantId":"300400500889",
"merchantName":"Test Merchant Order Name",
"merchantAddress":{
"address1":"123 MAIN ST",
"address2":"",
"city":"ANYTOWN",
"state":"NY",
"zip":"12345",
"country":"US",
"phone":"1234567890",
"contact":"JOHN SMITH"
},
"merchantShippingaddress":{
"address1":"456 ELM AVE",
"address2":null,
"city":"OTHERTOWN",
"state":"VT",
"zip":"67890",
"country":"US",
"phone":"9012345678",
"contact":"JANE DOE"
},
"lineItemDetail":[
{
"lineNumber":"002",
"partId":"LTR-WEL-FD35-R1",
"partDescription":"002",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"001",
"partId":"1PPRTPAK",
"partDescription":"001",
"orderedQuantity":"2",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"001",
"partId":"DEC-6SPOT-MED",
"partDescription":"001",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"003",
"partId":"DOWNLOADTASK",
"partDescription":"003",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"004",
"partId":"STCK-194321064",
"partDescription":"004",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"P"
},
{
"lineNumber":"001",
"partId":"DEC-FDMSHLPDESK",
"partDescription":"001",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"001",
"partId":"DOWNLOADTASK",
"partDescription":"001",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"001",
"partId":"MIS-FD130UGUIDE",
"partDescription":"001",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"002",
"partId":"N-FD-35-HW",
"partDescription":"002",
"orderedQuantity":"1",
"serialNumber":"102AA34567",
"parentChild":"P"
},
{
"lineNumber":"002",
"partId":"LTR-PPCAUTION",
"partDescription":"002",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"002",
"partId":"MIS-FD35HWINST1",
"partDescription":"002",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"001",
"partId":"N-FD-130-DUO",
"partDescription":"001",
"orderedQuantity":"1",
"serialNumber":"FD0000000000",
"parentChild":"P"
},
{
"lineNumber":"002",
"partId":"INJECTION",
"partDescription":"002",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"003",
"partId":"N-FD-130",
"partDescription":"003",
"orderedQuantity":"1",
"serialNumber":"FD0000000001",
"parentChild":"P"
},
{
"lineNumber":"001",
"partId":"ENV-FD",
"partDescription":"001",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"001",
"partId":"DEC-FD-2X4BXLBL",
"partDescription":"001",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"003",
"partId":"1PPRTPAK",
"partDescription":"003",
"orderedQuantity":"2",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"007",
"partId":"LTR-TRANSARMOR",
"partDescription":"007",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"P"
},
{
"lineNumber":"003",
"partId":"INJECTION",
"partDescription":"003",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"006",
"partId":"DEC-TRANSARM-R1",
"partDescription":"006",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"P"
},
{
"lineNumber":"003",
"partId":"DEC-FDMSHLPDESK",
"partDescription":"003",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"C"
},
{
"lineNumber":"005",
"partId":"MIS-194344064",
"partDescription":"005",
"orderedQuantity":"1",
"serialNumber":null,
"parentChild":"P"
}
]
}
}
This service retrieves the order information of a merchant for respective order number.
Request
GET /merchants/{merchantId}/orders/{orderNumber}
| Parameter | Description |
|---|---|
| merchantId | System generated Merchant ID. |
| orderNumber | Unique order number that identifies the order in the TASQ system. |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| orderNumber | Unique order number that identifies the order in the TASQ system. |
| orderDate | Date on which the order was placed. |
| shipDate | Date on which the order was shipped. |
| shipMethod | Type of shipping used by the Carrier for delivering the item(s). |
| shipMethodDescription | Description of the Shipping Method. |
| trackingDetails | Carrier provided details used to track shipments as they move from the origin of shipment to the destination. |
| trackingNumber | Unique identifier assigned by the Carrier to track shipment. |
| carrier | Deliver provider that is responsible for delivering the item(s). |
| ecollateral | Identifies whether the ordered item was delivered electronically. |
| merchantId | TASQ system field for the FD system generated merchant number. |
| merchantName | Name of the merchant that ordered the items. |
| merchantAddress | Address of the merchant that ordered the items. (refer to: merchantAddress and merchantShippingaddress Values). |
| merchantShippingaddress | Shipping address for the items. (refer to: merchantAddress and merchantShippingaddress Values). |
| lineItemDetail | (refer to: lineItemDetail Values). |
merchantAddress and merchantShippingaddress values
| Value | Meaning |
|---|---|
"address1" | |
"address2" | |
"city" | |
"state" | |
"zip" | |
"country" | |
"phone" | |
"contact" |
lineItemDetail values
| Value | Meaning |
|---|---|
"lineNumber" | Unique line item associated with the Part ID in the order. |
"partId" | Identifier for each item in the order. |
"partDescription" | Description for each Part ID in the order. |
"orderedQuantity" | Number of items ordered for each Part ID. |
"serialNumber" | Unique identifier assigned by the manufacturer of the of the Part in the order. |
"parentChild" | Identifies whether the Part is a parent or child. (refer to: lineItemDetail parentChild Values). |
lineItemDetail parentChild values
| Value | Meaning |
|---|---|
"P" | Identifies the parent Part in the order. |
"C" | Identifies that the Part is a child and associated with the parent. |
GET Deposit Amount Aggregated
# Don't forget to add your HMAC Authorization Headers
endpoint = "/api/manage/depositAmountAggregated/987654321?dateFrom=2018-01-09&dateTo=2018-01-15"
r = requests.get(url + endpoint, headers=headers)
print(r)
# Don't forget to add your HMAC Authorization Headers
ENDPOINT="$URL/api/manage/depositAmountAggregated/987654321?dateFrom=2018-01-09&dateTo=2018-01-15"
curl -X GET -H "date: $DATE" -H "Authorization: $HMAC_AUTH" $ENDPOINT
// Don't forget to add your HMAC Authorization Headers
var options = {
method: 'GET',
url: url + '/api/manage/depositAmountAggregated/987654321?dateFrom=2018-01-09&dateTo=2018-01-15',
headers: getAuthenticationHeaders()
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
HttpResponse response = null;
try {
response = doGet("/api/manage/depositAmountAggregated/987654321?dateFrom=2018-01-09&dateTo=2018-01-15");
int statusCode = response.getStatusLine().getStatusCode();
String response_string = EntityUtils.toString(response.getEntity());
System.out.println("json:" + response_string);
} catch (Exception e) {
e.printStackTrace();
}
<?php
# Don't forget to add your HMAC Authorization Headers
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/api/manage/depositAmountAggregated/987654321?dateFrom=2018-01-09&dateTo=2018-01-15");
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:
Success response
{
"errorDetails":null,
"message":null,
"responseCode":"success",
"reasonCode":"success",
"result":{
"netSalesDataTable":{
"columns":[
{
"title":"",
"amount":" 0.00",
"flag":"NS"
},
{
"title":"01/09/2018",
"amount":"$ 8,665.22",
"flag":"NS"
},
{
"title":"01/10/2018",
"amount":"$ 6,904.21",
"flag":"NS"
},
{
"title":"01/11/2018",
"amount":"$ 8,924.99",
"flag":"NS"
},
{
"title":"01/12/2018",
"amount":"$ -409.75",
"flag":"NS"
},
{
"title":"01/13/2018",
"amount":"$ 7,438.75",
"flag":"NS"
},
{
"title":"01/14/2018",
"amount":"$ 1,992.81",
"flag":"NS"
},
{
"title":"01/15/2018",
"amount":"$ 3,356.09",
"flag":"NS"
}
],
"rows":[
{
"c":[
{
"v":"0",
"f":""
},
{
"v":"8665.220",
"f":""
},
{
"v":"6904.210",
"f":""
},
{
"v":"8924.990",
"f":""
},
{
"v":"-409.750",
"f":""
},
{
"v":"7438.750",
"f":""
},
{
"v":"1992.810",
"f":""
},
{
"v":"3356.090",
"f":""
}
]
}
]
},
"expensesDataTable":{
"columns":[
{
"title":"",
"amount":"$ 0.00",
"flag":null
},
{
"title":"Fees",
"amount":"$ 0.00",
"flag":"F"
},
{
"title":"Adjustments",
"amount":"$ 0.00",
"flag":"A"
},
{
"title":"Chargebacks/Reversals",
"amount":"$ -150.00",
"flag":"C"
},
{
"title":"Service Charges",
"amount":"$ 0.00",
"flag":"SCH"
},
{
"title":"Third Party Adjustment",
"amount":"$ 19.53",
"flag":"TPA"
},
{
"title":"Interchange Charges",
"amount":"$ 0.00",
"flag":"ICH"
}
],
"rows":[
{
"c":[
{
"v":"0",
"f":""
},
{
"v":"0.000",
"f":""
},
{
"v":"0.000",
"f":""
},
{
"v":"-150.000",
"f":""
},
{
"v":"0.000",
"f":""
},
{
"v":"19.530",
"f":""
},
{
"v":"0.000",
"f":""
}
]
}
]
},
"netSalesTotal":"$ 36,872.32",
"expensesTotal":"$ -130.47",
"depositTotal":"$ 36,741.85",
"currencyType":"USD",
"currencyFormat":"$"
}
}
This service retrieves the aggregated deposit amount for respective merchant ID.
Request
GET /depositAmountAggregated/{merchantId}
| Parameter | Description |
|---|---|
| merchantId | Unique identifier that is generated by Business Track and associated with the MID. |
| startDate | |
| endDate |
Response
This endpoint returns an array of strings, each representing a feature.
| Parameter | Description |
|---|---|
| netSalesDataTable | Identifies the table as netSalesData. (refer to: netSalesDataTable Values). |
| expensesDataTable | Identifies the table as expensesData. (refer to: expensesDataTable Values). |
| netSalesTotal | Total amount of net sales. |
| expensesTotal | Total amount of expenses. |
| depositTotal | Total deposit amount calculated using netSalesTotal and expensesTotal. |
| currencyType | Type of currency used for the amounts in the table. |
| currencyFormat | Format used by the currencyType. |
netSalesDataTable values
| Parameter | Description |
|---|---|
| columns | Defines the columns for the Table. |
| title | Date to use as the title of the netSalesData column. |
| amount | Amount of associated with the title. |
| flag | Indicates the type of transaction for the title of the column. Possible values include: "NS" – Net Sales |
| rows | Defines the rows for the Table. (refer to: netSalesDataTable Row Values). |
netSalesDataTable rows values
| Value | Meaning |
|---|---|
"c" | Indicates columns for the rows. |
"v" | Amount of net sales for the date. |
"f" | Reserved for future use. |
expensesDataTable values
| Parameter | Description |
|---|---|
| columns | Defines the columns for the expensesDataTable. |
| title | Title of the column. |
| amount | Amount of the expense for the column. |
| flag | Indicates the type of expense in the column. (refer to: expensesDataTable Flag Values). |
| rows | Defines the rows for the expensesDataTable. (refer to: expensesDataTable Row Values). |
expensesDataTable flag values
| Value | Meaning |
|---|---|
"F" | Fees. |
"A" | Adjustments. |
"C" | Chargebacks/Reversals. |
"SCH" | Service Charges. |
"TPA" | Third Party Adjustment. |
"ICH" | Interchange Charges. |
expensesDataTable rows values
| Value | Meaning |
|---|---|
"c" | Indicates columns for the rows. |
"v" | Amount of net sales for the date. |
"f" | Reserved for future use. |