Query API

Overview

The Query API enables merchants to retrieve transaction information from the payment gateway. Look up previously processed transactions and obtain detailed information about their status, amounts, and other transaction details.

Use the Query API to verify transactions, reconcile accounts, and retrieve transaction history.

API Endpoint

POST https://api.ionicfi.com/api/query.php

Authentication

All Query API requests require your API Security Key:

security_key=YOUR_API_KEY

Generate new security keys from the merchant control panel: Settings > Security Keys

Query Types

Transaction Query
Batch Query
Date Range Query

Look up a specific transaction by ID.Request:

security_key=YOUR_API_KEY
transaction_id=123456789

Response:

response=1
transaction_id=123456789
transaction_type=sale
condition=complete
amount=99.99
cc_number=4xxxxxxxxxxx1111
cc_exp=1225
first_name=John
last_name=Doe

Retrieve all transactions from a specific batch.Request:

security_key=YOUR_API_KEY
batch_id=20251030

Response:

transactions[0][transaction_id]=123456789
transactions[0][amount]=99.99
transactions[0][type]=sale
transactions[1][transaction_id]=123456790
transactions[1][amount]=50.00
transactions[1][type]=auth

Get transactions within a date range.Request:

security_key=YOUR_API_KEY
start_date=20251001
end_date=20251031

Response: Returns all transactions processed between the specified dates.

Implementation Examples

<?php
$url = "https://api.ionicfi.com/api/query.php";

$data = array(
    "security_key" => "YOUR_API_KEY",
    "transaction_id" => "123456789"
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$response = curl_exec($ch);
curl_close($ch);

parse_str($response, $result);
print_r($result);
?>

Query Parameters

Transaction Query

Parameter	Description	Required
`security_key`	Your API security key	Yes
`transaction_id`	Transaction ID to query	Yes

Batch Query

Parameter	Description	Required
`security_key`	Your API security key	Yes
`batch_id`	Batch ID to query	Yes

Date Range Query

Parameter	Description	Required	Format
`security_key`	Your API security key	Yes	String
`start_date`	Beginning date	Yes	YYYYMMDD
`end_date`	Ending date	Yes	YYYYMMDD
`limit`	Max results to return	No	Integer
`offset`	Pagination offset	No	Integer

Response Format

Transaction responses are returned in query string format:

response=1&transaction_id=123456789&amount=99.99&cc_number=4xxxxxxxxxxx1111

Parse the response by splitting on & and then on =:

parse_str($response, $result);
echo $result['amount']; // 99.99

Response Fields

Transaction Information

Field	Description
`transaction_id`	Unique transaction identifier
`transaction_type`	Type: sale, auth, capture, void, refund, credit
`condition`	Transaction status: complete, pending, failed, unknown
`amount`	Transaction amount
`currency`	Currency code (USD, etc.)
`processor_id`	Processor that handled transaction

Payment Method

Field	Description
`cc_number`	Masked card number (e.g., 4xxxxxxxxxxx1111)
`cc_exp`	Card expiration (MMYY)
`card_type`	Card brand: Visa, Mastercard, Amex, Discover
`check_account`	Masked account number (for ACH)
`check_aba`	Routing number (for ACH)
`account_type`	checking or savings

Customer Information

Field	Description
`first_name`	Customer first name
`last_name`	Customer last name
`company`	Company name
`address1`	Billing address line 1
`address2`	Billing address line 2
`city`	City
`state`	State
`zip`	Postal code
`country`	Country code
`phone`	Phone number
`email`	Email address

Response Details

Field	Description
`response`	1=success, 2=decline, 3=error
`responsetext`	Response description
`authcode`	Authorization code from processor
`avsresponse`	AVS response code
`cvvresponse`	CVV response code
`orderid`	Merchant order ID

Additional Fields

Field	Description
`created`	Transaction timestamp
`settled`	Settlement timestamp
`batch_id`	Settlement batch ID
`customer_vault_id`	Customer vault ID (if used)
`partial_payment_id`	Partial payment ID (if applicable)

Transaction Status

The condition field indicates transaction status:

complete
pending
failed
unknown

Transaction processed successfully and is settled or pending settlement.Action: No action needed

Batch Queries

Query all transactions in a settlement batch:

security_key=YOUR_API_KEY
batch_id=20251030

Response Format:

total_count=150
total_amount=15000.00
transactions[0][transaction_id]=123456789
transactions[0][amount]=99.99
transactions[0][type]=sale
transactions[0][status]=complete
transactions[1][transaction_id]=123456790
transactions[1][amount]=50.00
transactions[1][type]=auth
transactions[1][status]=complete

Parse the response to access individual transactions:

parse_str($response, $result);
echo "Total transactions: " . $result['total_count'];
foreach ($result['transactions'] as $txn) {
    echo "Transaction ID: " . $txn['transaction_id'];
    echo "Amount: " . $txn['amount'];
}

Date Range Queries

Query transactions within a date range:

security_key=YOUR_API_KEY
start_date=20251001
end_date=20251031
limit=100
offset=0

Parameters:

start_date: Beginning date (YYYYMMDD)
end_date: Ending date (YYYYMMDD)
limit: Maximum results per request (default: 100, max: 1000)
offset: Pagination offset for large result sets

Pagination Example:

// Get first 100 transactions
$offset = 0;
$limit = 100;

do {
    $data = array(
        "security_key" => "YOUR_API_KEY",
        "start_date" => "20251001",
        "end_date" => "20251031",
        "limit" => $limit,
        "offset" => $offset
    );

    // Make query request
    $response = makeQuery($data);
    parse_str($response, $result);

    // Process transactions
    processTransactions($result['transactions']);

    $offset += $limit;

} while (count($result['transactions']) == $limit);

Error Handling

Common query errors:

Error	Description	Resolution
`Invalid transaction ID`	Transaction not found	Verify transaction ID
`Invalid security key`	Authentication failed	Check API key
`Access denied`	Transaction belongs to different merchant	Verify merchant account
`Invalid date format`	Date format incorrect	Use YYYYMMDD format

Rate Limiting

The Query API implements rate limiting:

100 requests per minute per API key
10,000 requests per day per merchant account

Exceeding rate limits results in temporary API access suspension. Implement exponential backoff for retries.

Use Cases

Transaction Verification

Verify transaction status after processing:

// After payment redirect
$transaction_id = $_GET['transaction_id'];
$result = queryTransaction($transaction_id);

if ($result['condition'] == 'complete' && $result['response'] == '1') {
    // Transaction successful
    completeOrder();
}

Account Reconciliation

Reconcile transactions against your records:

// Daily reconciliation
$today = date('Ymd');
$result = queryDateRange($today, $today);
reconcileWithDatabase($result['transactions']);

Customer Transaction History

Retrieve customer’s transaction history:

// Get all transactions for a customer
$customer_vault_id = '123456';
$transactions = queryCustomerTransactions($customer_vault_id);
displayToCustomer($transactions);

Reporting

Generate transaction reports:

// Monthly report
$start = '20251001';
$end = '20251031';
$transactions = queryDateRange($start, $end);
generateReport($transactions);

Best Practices

Cache Results

Cache query results to reduce API calls and improve performance

Batch Processing

Use batch queries instead of individual transaction queries when possible

Error Handling

Implement robust error handling and retry logic

Rate Limiting

Respect rate limits and implement exponential backoff

Next Steps

Payment API

Process transactions

Webhooks

Real-time notifications

Response Codes

Understand response codes

Customer Vault

Query customer information

Getting Started

Integration Methods

Partners

API Reference

Overview

API Endpoint

Authentication

Query Types

Implementation Examples

Query Parameters

Transaction Query

Batch Query

Date Range Query

Response Format

Response Fields

Transaction Information

Payment Method

Customer Information

Response Details

Additional Fields

Transaction Status

Batch Queries

Date Range Queries

Error Handling

Rate Limiting

Use Cases

Best Practices

Cache Results

Batch Processing

Error Handling

Rate Limiting

Next Steps

Payment API

Webhooks

Response Codes

Customer Vault

Getting Started

Integration Methods

Partners

API Reference

​Overview

​API Endpoint

​Authentication

​Query Types

​Implementation Examples

​Query Parameters

​Transaction Query

​Batch Query

​Date Range Query

​Response Format

​Response Fields

​Transaction Information

​Payment Method

​Customer Information

​Response Details

​Additional Fields

​Transaction Status

​Batch Queries

​Date Range Queries

​Error Handling

​Rate Limiting

​Use Cases

​Best Practices

Cache Results

Batch Processing

Error Handling

Rate Limiting

​Next Steps

Payment API

Webhooks

Response Codes

Customer Vault

Overview

API Endpoint

Authentication

Query Types

Implementation Examples

Query Parameters

Transaction Query

Batch Query

Date Range Query

Response Format

Response Fields

Transaction Information

Payment Method

Customer Information

Response Details

Additional Fields

Transaction Status

Batch Queries

Date Range Queries

Error Handling

Rate Limiting

Use Cases

Best Practices

Next Steps