API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

ENDPOINTS

Sandbox: https://paymentreportingdemo.iqmetrix.net/v1
Production: https://paymentreporting.iqmetrix.net/v1

RESOURCES

Transaction

[
    {
        "Id": 151,
        "Amount": 4,
        "CardBin": "545454",
        "CardholderName": "John Test",
        "CardType": "VISA",
        "CompanyID": 14146,
        "EntryType": "Swiped",
        "LastFourDigits": "5454",
        "MerchantNumber": "1111",
        "MessageDate": "2015-01-28T16:31:58.877",
        "ProviderID": "79f417f1-769f-4118-a32b-7eeebc81c888",
        "RequestType": "MerchantCredentialsLoadForStore",
        "StoreID": 14192,
        "TerminalNumber": "123",
        "VoidReason": "Auto Void from Incomplete Invoice",
        "VoidedBy": 5125,
        "AuthorizationNumber": "ABS251",
        "AuthorizedAmount": 4,
        "ErrorMessage": "Authentication Error",
        "ResponseCode": "AA",
        "ResponseMessage": "APPROVAL",
        "ReversedBy": 0
    }
]
Name Description
Id (Integer) Unique identifier
Amount (Decimal) Amount requested
CardBin (String) The payment cards Bank Identifiation Number (BIN)
CardholderName (String) Name of Cardholder
CardType (INT) Card type name. See Getting Card Types for a list of possible values
CompanyID (Integer) Identifier for a Company
EntryType (INT) Entry type name. See Getting Entry Types for a list of possible values
LastFourDigits (VARCHAR(4)) Last four digits of card
MerchantNumber (VARCHAR(50)) The Merchant Number / ID used in payment credentials for this transaction
MessageDate (DateTime) Date of Transaction in UTC
ProviderID (UNIQUEIDENTIFIER) Identifier for a Payment Processor to indicate which payment processor was used. See PaymentProcessor for a list of possible values
RequestType (INT) Type of request. See Getting Request Types for a list of possible values
StoreID (INT) Identifier for a Location
TerminalNumber (VARCHAR(50)) The Terminal Number / ID used in payment credentials for this transaction
VoidReason (VARCHAR(150)) String explanation on why the original transaction was voided. Only appears on void transactions, not on the original sale transation
VoidedBy (BIGINT) RequestID of the transaction that voided this transaction. If this is not null, the transaction was voided. The Void Reason can be found on the void transaction
AuthorizationNumber (VARCHAR(10)) Authorization Number from Payment Processor
AuthorizedAmount (MONEY) Amount approved
ErrorMessage (VARCHAR(100)) Error Message From Payment Processor
ResponseCode (VARCHAR(10)) Response code received directly from payment processor
ResponseMessage (VARCHAR(100)) Response messages received directly from payment processor
ReversedBy (BIGINT) RequestID of the transaction that reversed this transaction. If this is not null then the transaction was reversed

REQUESTS

GET Payments for a Company

Request

GET /Transactions/report?filter=CompanyId eq {CompanyId} and messageDate gt '{StartDate}'&PageSize={PageSize}&Page={Page}

Example Request

GET /Transactions/report?filter=CompanyId eq 19761 and messageDate gt '2016-10-14T06:00:00.000Z'&PageSize=10&Page=1
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://paymentreportingdemo.iqmetrix.net/v1/Transactions/report?filter=CompanyId eq 19761 and messageDate gt '2016-10-14T06:00:00.000Z'&PageSize=10&Page=1" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingPaymentsForACompany()
{
    var client = new RestClient("https://paymentreportingdemo.iqmetrix.net/v1/Transactions/report?filter=CompanyId eq 19761 and messageDate gt '2016-10-14T06:00:00.000Z'&PageSize=10&Page=1");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingPaymentsForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://paymentreportingdemo.iqmetrix.net/v1/Transactions/report?filter=CompanyId eq 19761 and messageDate gt '2016-10-14T06:00:00.000Z'&PageSize=10&Page=1");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://paymentreportingdemo.iqmetrix.net/v1/Transactions/report?filter=CompanyId eq 19761 and messageDate gt '2016-10-14T06:00:00.000Z'&PageSize=10&Page=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": 151,
        "Amount": 4,
        "CardBin": "545454",
        "CardholderName": "John Test",
        "CardType": "VISA",
        "CompanyID": 14146,
        "EntryType": "Swiped",
        "LastFourDigits": "5454",
        "MerchantNumber": "1111",
        "MessageDate": "2015-01-28T16:31:58.877",
        "ProviderID": "79f417f1-769f-4118-a32b-7eeebc81c888",
        "RequestType": "MerchantCredentialsLoadForStore",
        "StoreID": 14192,
        "TerminalNumber": "123",
        "VoidReason": "Auto Void from Incomplete Invoice",
        "VoidedBy": 5125,
        "AuthorizationNumber": "ABS251",
        "AuthorizedAmount": 4,
        "ErrorMessage": "Authentication Error",
        "ResponseCode": "AA",
        "ResponseMessage": "APPROVAL",
        "ReversedBy": 0
    }
]

Array[Transaction]

Was this page helpful?