transmitInquire

Overview

The transmitInquire command retrieves metadata and status information about transmissions that have been sent to Shva, Israel's central clearing network. This command provides detailed information about transmission batches, including transmission time, number of transactions, success/failure status, and related identifiers.

This command is essential for merchants who need to track, audit, or troubleshoot their settlement transmissions, enabling comprehensive reconciliation and monitoring of the transmission process.

Use cases

Transmission status verification: Check if transmissions to Shva completed successfully or encountered errors
Reconciliation and auditing: Gather detailed transmission data for accounting and compliance purposes
Debugging transmission issues: Investigate failed or incomplete transmissions to identify problems
Settlement monitoring: Track when transactions were transmitted and processed by Shva
Batch analysis: Review transmission batches to understand settlement patterns and timing
Compliance reporting: Generate reports on transmission activities for regulatory requirements
Post-transmission validation: Verify transmission results after using transmitTerminal command

Request structure

For a comprehensive overview of the API request format and authentication, see API Request & Response General Structure.

Send a standard Hyp API request to your assigned server endpoint with the transmitInquire command in the int_in parameter.

Server Endpoints: Use the server endpoint provided during merchant onboarding (e.g., https://your-hyp-environment-url/xpo/Relay).

XML payload structure

<ashrait>
    <request>
        <version>2000</version>
        <language>Eng</language>
        <dateTime/>
        <requestId/>
        <command>transmitInquire</command>
        <transmitInquire>
            <terminalNumber>{terminalNumber}</terminalNumber>
            <!-- Optional search criteria -->
            <transmitId>{transmitId}</transmitId>
        </transmitInquire>
    </request>
</ashrait>

Required parameters

terminalNumber - Your merchant terminal identifier

Type: String (Numeric, 10 digits) Required: Yes Description: The unique terminal number assigned during merchant onboarding

Example: 0882819014

Usage Notes:

Must match your assigned terminal number
Used for identifying which terminal's transmissions to query
Available in your merchant dashboard

Optional parameters

transmitId - Specific transmission identifier

Type: String (Numeric, 1-20 digits) Required: No Description: Query a specific transmission batch by its unique identifier

Example: 987654321

Usage Notes:

Use to get details about a specific transmission batch
Transmission ID is returned in responses from transmitTerminal command
When specified, returns detailed information about that specific transmission

fromTransmitDateTime / toTransmitDateTime - Transmission date/time range

Type: String (DateTime format) Required: No Description: Date and time range filter for transmission queries

Format: YYYY-MM-DD HH:MM:SS or system-specific datetime format Example: 2025-07-24 08:00:00

Usage Notes:

Use both parameters together to define a datetime range
Filters transmissions by when they were sent to Shva
Useful for querying transmissions within specific time periods

shvaReferanceNo - Shva reference number

Type: String (Numeric, 7-8 digits) Required: No Description: Query transmissions by Shva reference number

Example: 5568985

Usage Notes:

Reference number assigned by Shva for transmission batches
Use to find specific transmissions when you have the Shva reference
Helpful for reconciling with Shva reports

transmitType - Type of transmission

Type: String (Enum) Required: No Description: Filter transmissions by type

Valid Values: Refer to Hyp integration documentation for available transmission types Example: STANDARD

Usage Notes:

Filter results to specific transmission types
Useful when different transmission types are used for different purposes
Must match the transmission type values used in your environment

Response structure

Successful response example

<?xml version='1.0'?>
<ashrait>
    <response>
        <command>transmitInquire</command>
        <dateTime>2025-08-27 09:25</dateTime>
        <requestId />
        <tranId>119717968</tranId>
        <result>000</result>
        <message>Permitted transaction</message>
        <userMessage>Permitted transaction</userMessage>
        <additionalInfo />
        <version>2000</version>
        <language>Eng</language>
        <transmitInquire>
            <status>000</status>
            <message>Permitted transaction</message>
            <userMessage>Permitted transaction</userMessage>
            <terminalNumber>0882804010</terminalNumber>
            <transmitId>1602663</transmitId>
            <transmitType>settlements</transmitType>
            <transmitStatus>completed</transmitStatus>
            <startDateTime>2025-08-25 23:02:42</startDateTime>
            <endDateTime>2025-08-25 23:02:43</endDateTime>
            <transmitStatistics>
                <ref>
                    <shvaReferanceNo>04646417</shvaReferanceNo>
                    <tranbName />
                    <countTransmitted>7</countTransmitted>
                    <fileNumber>63</fileNumber>
                    <currencyTotal>
                        <currency>ILS</currency>
                        <amountDebit>288629</amountDebit>
                        <countDebit>5</countDebit>
                        <amountCredit>166308</amountCredit>
                        <countCredit>2</countCredit>
                    </currencyTotal>
                    <isracard>
                        <currencyTotal>
                            <currency>ILS</currency>
                            <amountDebit>4329</amountDebit>
                            <countDebit>2</countDebit>
                            <amountCredit>166308</amountCredit>
                            <countCredit>2</countCredit>
                        </currencyTotal>
                    </isracard>
                    <visa>
                        <currencyTotal>
                            <currency>ILS</currency>
                            <amountDebit>800</amountDebit>
                            <countDebit>1</countDebit>
                            <amountCredit>0</amountCredit>
                            <countCredit>0</countCredit>
                        </currencyTotal>
                    </visa>
                    <diners>
                        <currencyTotal>
                            <currency>ILS</currency>
                            <amountDebit>0</amountDebit>
                            <countDebit>0</countDebit>
                            <amountCredit>0</amountCredit>
                            <countCredit>0</countCredit>
                        </currencyTotal>
                    </diners>
                    <amex>
                        <currencyTotal>
                            <currency>ILS</currency>
                            <amountDebit>0</amountDebit>
                            <countDebit>0</countDebit>
                            <amountCredit>0</amountCredit>
                            <countCredit>0</countCredit>
                        </currencyTotal>
                    </amex>
                    <tranzila>
                        <currencyTotal>
                            <currency>ILS</currency>
                            <amountDebit>0</amountDebit>
                            <countDebit>0</countDebit>
                            <amountCredit>0</amountCredit>
                            <countCredit>0</countCredit>
                        </currencyTotal>
                    </tranzila>
                    <alphacard>
                        <currencyTotal>
                            <currency>ILS</currency>
                            <amountDebit>283500</amountDebit>
                            <countDebit>2</countDebit>
                            <amountCredit>0</amountCredit>
                            <countCredit>0</countCredit>
                        </currencyTotal>
                    </alphacard>
                    <cardcom>
                        <currencyTotal>
                            <currency>ILS</currency>
                            <amountDebit>0</amountDebit>
                            <countDebit>0</countDebit>
                            <amountCredit>0</amountCredit>
                            <countCredit>0</countCredit>
                        </currencyTotal>
                    </cardcom>
                    <slip />
                </ref>
            </transmitStatistics>
        </transmitInquire>
    </response>
</ashrait>

Key Response Fields:

result: 000 indicates successful inquiry
transmitId: Unique identifier for this transmission batch
transmitStatus: Status of transmission (completed, failed, pending, etc.)
startDateTime/endDateTime: When transmission started and ended
transmitStatistics: Detailed statistics including:
- shvaReferanceNo: Shva reference number for the transmission
- countTransmitted: Total number of transactions transmitted
- currencyTotal: Overall amounts and counts by debit/credit
- Card company breakdowns (isracard, visa, diners, amex, etc.)

Error response example

<?xml version='1.0'?>
<ashrait>
    <response>
        <command>transmitInquire</command>
        <dateTime>2025-08-27 09:26</dateTime>
        <requestId />
        <tranId>119717976</tranId>
        <result>500</result>
        <message>TransmitId was not found</message>
        <userMessage>transmitId was not found</userMessage>
        <additionalInfo />
        <version>2000</version>
        <language>Eng</language>
        <transmitInquire />
    </response>
</ashrait>

Key Error Fields:

result: Error code (500 in this example)
message/userMessage: Description of the error
transmitInquire: Empty element when no data is found

Code examples

#!/bin/bash

# Query specific transmission by ID
curl -X POST https://your-hyp-environment-url/xpo/Relay \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "user=your_username" \
  -d "password=your_password" \
  -d "int_in=$(cat <<'EOF'
<ashrait>
    <request>
        <version>2000</version>
        <language>Eng</language>
        <dateTime/>
        <requestId/>
        <command>transmitInquire</command>
        <transmitInquire>
            <terminalNumber>0882819014</terminalNumber>
            <transmitId>987654321</transmitId>
        </transmitInquire>
    </request>
</ashrait>
EOF
)"

# Query transmissions by date range
curl -X POST https://your-hyp-environment-url/xpo/Relay \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "user=your_username" \
  -d "password=your_password" \
  -d "int_in=$(cat <<'EOF'
<ashrait>
    <request>
        <version>2000</version>
        <language>Eng</language>
        <dateTime/>
        <requestId/>
        <command>transmitInquire</command>
        <transmitInquire>
            <terminalNumber>0882819014</terminalNumber>
            <fromTransmitDateTime>2025-07-24 08:00:00</fromTransmitDateTime>
            <toTransmitDateTime>2025-07-24 23:59:59</toTransmitDateTime>
        </transmitInquire>
    </request>
</ashrait>
EOF
)"

import java.io.*;
import java.net.*;
import java.nio.charset.StandardCharsets;
import java.util.*;

public class TransmitInquireExample {
    
    public static class TransmissionInquiryResult {
        public boolean success;
        public List<Transmission> transmissions;
        public Summary summary;
        public String error;
        
        public static class Transmission {
            public String transmitId;
            public String transmissionDate;
            public String transmissionTime;
            public String status;
            public int transactionCount;
            public String totalAmount;
            public String shvaReferanceNo;
            public String transmitType;
        }
        
        public static class Summary {
            public int totalTransmissions;
            public int totalTransactions;
            public String totalAmount;
        }
    }
    
    public static TransmissionInquiryResult inquireTransmissions(String terminalNumber, String transmitId, 
                                                               String fromDateTime, String toDateTime) throws IOException {
        String serverUrl = "https://your-hyp-environment-url/xpo/Relay";
        String username = "your_username";
        String password = "your_password";
        
        TransmissionInquiryResult result = new TransmissionInquiryResult();
        result.transmissions = new ArrayList<>();
        result.summary = new TransmissionInquiryResult.Summary();
        
        // Build XML payload
        StringBuilder xmlPayload = new StringBuilder();
        xmlPayload.append("<ashrait>")
                  .append("<request>")
                  .append("<version>2000</version>")
                  .append("<language>Eng</language>")
                  .append("<dateTime/>")
                  .append("<requestId/>")
                  .append("<command>transmitInquire</command>")
                  .append("<transmitInquire>")
                  .append("<terminalNumber>").append(terminalNumber).append("</terminalNumber>");
        
        if (transmitId != null && !transmitId.isEmpty()) {
            xmlPayload.append("<transmitId>").append(transmitId).append("</transmitId>");
        }
        
        if (fromDateTime != null && toDateTime != null) {
            xmlPayload.append("<fromTransmitDateTime>").append(fromDateTime).append("</fromTransmitDateTime>")
                      .append("<toTransmitDateTime>").append(toDateTime).append("</toTransmitDateTime>");
        }
        
        xmlPayload.append("</transmitInquire>")
                  .append("</request>")
                  .append("</ashrait>");
        
        // Build POST data
        String postData = "user=" + URLEncoder.encode(username, StandardCharsets.UTF_8) +
                         "&password=" + URLEncoder.encode(password, StandardCharsets.UTF_8) +
                         "&int_in=" + URLEncoder.encode(xmlPayload.toString(), StandardCharsets.UTF_8);
        
        // Send request
        URL url = new URL(serverUrl);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        connection.setRequestMethod("POST");
        connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
        connection.setDoOutput(true);
        
        try (OutputStream os = connection.getOutputStream()) {
            os.write(postData.getBytes(StandardCharsets.UTF_8));
        }
        
        // Read response
        try (BufferedReader reader = new BufferedReader(
                new InputStreamReader(connection.getInputStream()))) {
            String line;
            StringBuilder response = new StringBuilder();
            while ((line = reader.readLine()) != null) {
                response.append(line);
            }
            
            // Parse response (simplified - use proper XML parser in production)
            String responseText = response.toString();
            if (responseText.contains("<result>000</result>")) {
                result.success = true;
                
                // Extract transmission details (simplified parsing)
                TransmissionInquiryResult.Transmission transmission = new TransmissionInquiryResult.Transmission();
                transmission.transmitId = extractValue(responseText, "transmitId");
                transmission.transmissionDate = extractValue(responseText, "startDateTime");
                transmission.transmissionTime = extractValue(responseText, "endDateTime");
                transmission.status = extractValue(responseText, "transmitStatus");
                transmission.transactionCount = Integer.parseInt(extractValue(responseText, "countTransmitted"));
                transmission.totalAmount = extractValue(responseText, "amountDebit");
                transmission.shvaReferanceNo = extractValue(responseText, "shvaReferanceNo");
                transmission.transmitType = extractValue(responseText, "transmitType");
                result.transmissions.add(transmission);
                
                // Extract summary
                result.summary.totalTransmissions = result.transmissions.size();
                result.summary.totalTransactions = transmission.transactionCount;
                result.summary.totalAmount = transmission.totalAmount;
            } else {
                result.success = false;
                result.error = extractValue(responseText, "userMessage");
            }
        }
        
        return result;
    }
    
    private static String extractValue(String xml, String tagName) {
        String startTag = "<" + tagName + ">";
        String endTag = "</" + tagName + ">";
        int start = xml.indexOf(startTag);
        if (start != -1) {
            start += startTag.length();
            int end = xml.indexOf(endTag, start);
            if (end != -1) {
                return xml.substring(start, end);
            }
        }
        return "0";
    }
    
    public static void main(String[] args) throws IOException {
        // Query specific transmission
        TransmissionInquiryResult result = inquireTransmissions("0882819014", "987654321", null, null);
        
        if (result.success) {
            System.out.println("Transmission inquiry successful!");
            System.out.println("Found " + result.summary.totalTransmissions + " transmissions");
            
            for (TransmissionInquiryResult.Transmission tx : result.transmissions) {
                System.out.println("Transmission ID: " + tx.transmitId);
                System.out.println("Status: " + tx.status);
                System.out.println("Type: " + tx.transmitType);
                System.out.println("Transaction Count: " + tx.transactionCount);
                System.out.println("Start Time: " + tx.transmissionDate);
                System.out.println("End Time: " + tx.transmissionTime);
                System.out.println("Shva Reference: " + tx.shvaReferanceNo);
            }
        } else {
            System.out.println("Transmission inquiry failed: " + result.error);
        }
    }
}

import requests
from urllib.parse import urlencode
from xml.etree import ElementTree as ET
from typing import List, Dict, Optional

def inquire_transmissions(terminal_number: str, transmit_id: str = None, 
                         from_datetime: str = None, to_datetime: str = None,
                         shva_reference_no: str = None) -> Dict:
    """Inquire transmission status and details"""
    
    server_url = "https://your-hyp-environment-url/xpo/Relay"
    username = "your_username"
    password = "your_password"
    
    # Build XML payload
    xml_payload = f"""
    <ashrait>
        <request>
            <version>2000</version>
            <language>Eng</language>
            <dateTime/>
            <requestId/>
            <command>transmitInquire</command>
            <transmitInquire>
                <terminalNumber>{terminal_number}</terminalNumber>
                {f'<transmitId>{transmit_id}</transmitId>' if transmit_id else ''}
                {f'<fromTransmitDateTime>{from_datetime}</fromTransmitDateTime>' if from_datetime else ''}
                {f'<toTransmitDateTime>{to_datetime}</toTransmitDateTime>' if to_datetime else ''}
                {f'<shvaReferanceNo>{shva_reference_no}</shvaReferanceNo>' if shva_reference_no else ''}
            </transmitInquire>
        </request>
    </ashrait>
    """
    
    # Prepare POST data
    post_data = {
        'user': username,
        'password': password,
        'int_in': xml_payload.strip()
    }
    
    try:
        # Send request
        response = requests.post(
            server_url,
            data=post_data,
            headers={'Content-Type': 'application/x-www-form-urlencoded'},
            timeout=30
        )
        
        response.raise_for_status()
        
        # Parse XML response
        root = ET.fromstring(response.text)
        result_code = root.find('.//result').text
        
        if result_code == '000':
            transmissions = []
            
            # Extract transmission details
            inquiry_elem = root.find('.//transmitInquire')
            if inquiry_elem is not None:
                transmission = {
                    'transmit_id': inquiry_elem.find('transmitId').text if inquiry_elem.find('transmitId') is not None else '',
                    'transmit_status': inquiry_elem.find('transmitStatus').text if inquiry_elem.find('transmitStatus') is not None else '',
                    'transmit_type': inquiry_elem.find('transmitType').text if inquiry_elem.find('transmitType') is not None else '',
                    'start_datetime': inquiry_elem.find('startDateTime').text if inquiry_elem.find('startDateTime') is not None else '',
                    'end_datetime': inquiry_elem.find('endDateTime').text if inquiry_elem.find('endDateTime') is not None else '',
                    'terminal_number': inquiry_elem.find('terminalNumber').text if inquiry_elem.find('terminalNumber') is not None else '',
                    'shva_reference_no': '',
                    'transaction_count': 0,
                    'total_amount_debit': '0',
                    'total_amount_credit': '0'
                }
                
                # Extract statistics if available
                stats_elem = inquiry_elem.find('transmitStatistics/ref')
                if stats_elem is not None:
                    transmission['shva_reference_no'] = stats_elem.find('shvaReferanceNo').text if stats_elem.find('shvaReferanceNo') is not None else ''
                    transmission['transaction_count'] = int(stats_elem.find('countTransmitted').text) if stats_elem.find('countTransmitted') is not None else 0
                    
                    currency_total = stats_elem.find('currencyTotal')
                    if currency_total is not None:
                        transmission['total_amount_debit'] = currency_total.find('amountDebit').text if currency_total.find('amountDebit') is not None else '0'
                        transmission['total_amount_credit'] = currency_total.find('amountCredit').text if currency_total.find('amountCredit') is not None else '0'
                
                transmissions.append(transmission)
            
            # Create summary from the transmission data
            summary = {
                'total_transmissions': len(transmissions),
                'total_transactions': sum(tx.get('transaction_count', 0) for tx in transmissions),
                'total_amount_debit': sum(int(tx.get('total_amount_debit', '0')) for tx in transmissions),
                'total_amount_credit': sum(int(tx.get('total_amount_credit', '0')) for tx in transmissions)
            }
            
            return {
                'success': True,
                'transmissions': transmissions,
                'summary': summary,
                'message': root.find('.//userMessage').text
            }
        else:
            return {
                'success': False,
                'error_code': result_code,
                'error': root.find('.//userMessage').text
            }
            
    except requests.exceptions.RequestException as e:
        return {
            'success': False,
            'error': f"Request failed: {e}"
        }
    except ET.ParseError as e:
        return {
            'success': False,
            'error': f"XML parsing failed: {e}"
        }

# Example usage
if __name__ == "__main__":
    # Query specific transmission
    result = inquire_transmissions("0882819014", transmit_id="987654321")
    
    if result['success']:
        print("Transmission inquiry successful!")
        print(f"Found {result['summary'].get('total_transmissions', 0)} transmissions")
        
        for transmission in result['transmissions']:
            print(f"Transmission ID: {transmission['transmit_id']}")
            print(f"Status: {transmission['transmit_status']}")
            print(f"Type: {transmission['transmit_type']}")
            print(f"Transaction Count: {transmission['transaction_count']}")
            print(f"Start Time: {transmission['start_datetime']}")
            print(f"End Time: {transmission['end_datetime']}")
            print(f"Shva Reference: {transmission['shva_reference_no']}")
            print(f"Debit Amount: {transmission['total_amount_debit']}")
            print(f"Credit Amount: {transmission['total_amount_credit']}")
            print("---")
    else:
        print(f"Transmission inquiry failed: {result['error']}")
    
    # Query transmissions by date range
    date_result = inquire_transmissions(
        "0882819014",
        from_datetime="2025-07-24 08:00:00",
        to_datetime="2025-07-24 23:59:59"
    )
    
    if date_result['success']:
        print(f"Date range inquiry found {len(date_result['transmissions'])} transmissions")
        total_transactions = sum(tx['transaction_count'] for tx in date_result['transmissions'])
        print(f"Total transactions transmitted: {total_transactions}")
    else:
        print(f"Date range inquiry failed: {date_result['error']}")

const https = require('https');
const querystring = require('querystring');
const { parseStringPromise } = require('xml2js');

function inquireTransmissions(terminalNumber, options = {}) {
    return new Promise((resolve, reject) => {
        const serverUrl = 'https://your-hyp-environment-url/xpo/Relay';
        const username = 'your_username';
        const password = 'your_password';
        
        // Build XML payload
        let xmlPayload = `
        <ashrait>
            <request>
                <version>2000</version>
                <language>Eng</language>
                <dateTime/>
                <requestId/>
                <command>transmitInquire</command>
                <transmitInquire>
                    <terminalNumber>${terminalNumber}</terminalNumber>`;
        
        if (options.transmitId) {
            xmlPayload += `<transmitId>${options.transmitId}</transmitId>`;
        }
        
        if (options.fromDateTime && options.toDateTime) {
            xmlPayload += `<fromTransmitDateTime>${options.fromDateTime}</fromTransmitDateTime>`;
            xmlPayload += `<toTransmitDateTime>${options.toDateTime}</toTransmitDateTime>`;
        }
        
        if (options.shvaReferenceNo) {
            xmlPayload += `<shvaReferanceNo>${options.shvaReferenceNo}</shvaReferanceNo>`;
        }
        
        xmlPayload += `
                </transmitInquire>
            </request>
        </ashrait>
        `;
        
        // Prepare POST data
        const postData = querystring.stringify({
            user: username,
            password: password,
            int_in: xmlPayload.trim()
        });
        
        const requestOptions = {
            method: 'POST',
            headers: {
                'Content-Type': 'application/x-www-form-urlencoded',
                'Content-Length': Buffer.byteLength(postData)
            }
        };
        
        const req = https.request(serverUrl, requestOptions, async (res) => {
            let responseData = '';
            
            res.on('data', (chunk) => {
                responseData += chunk;
            });
            
            res.on('end', async () => {
                try {
                    if (res.statusCode === 200) {
                        // Parse XML response
                        const result = await parseStringPromise(responseData);
                        const response = result.ashrait.response[0];
                        const resultCode = response.result[0];
                        
                        if (resultCode === '000') {
                            const inquiryData = response.transmitInquire[0];
                            const transmissions = [];
                            
                            // Extract transmission details
                            const transmission = {
                                transmitId: inquiryData.transmitId ? inquiryData.transmitId[0] : '',
                                transmitStatus: inquiryData.transmitStatus ? inquiryData.transmitStatus[0] : '',
                                transmitType: inquiryData.transmitType ? inquiryData.transmitType[0] : '',
                                startDateTime: inquiryData.startDateTime ? inquiryData.startDateTime[0] : '',
                                endDateTime: inquiryData.endDateTime ? inquiryData.endDateTime[0] : '',
                                terminalNumber: inquiryData.terminalNumber ? inquiryData.terminalNumber[0] : '',
                                shvaReferanceNo: '',
                                transactionCount: 0,
                                totalAmountDebit: '0',
                                totalAmountCredit: '0'
                            };
                            
                            // Extract statistics if available
                            if (inquiryData.transmitStatistics && inquiryData.transmitStatistics[0].ref) {
                                const ref = inquiryData.transmitStatistics[0].ref[0];
                                transmission.shvaReferanceNo = ref.shvaReferanceNo ? ref.shvaReferanceNo[0] : '';
                                transmission.transactionCount = ref.countTransmitted ? parseInt(ref.countTransmitted[0]) : 0;
                                
                                if (ref.currencyTotal && ref.currencyTotal[0]) {
                                    const currencyTotal = ref.currencyTotal[0];
                                    transmission.totalAmountDebit = currencyTotal.amountDebit ? currencyTotal.amountDebit[0] : '0';
                                    transmission.totalAmountCredit = currencyTotal.amountCredit ? currencyTotal.amountCredit[0] : '0';
                                }
                            }
                            
                            transmissions.push(transmission);
                            
                            // Create summary from transmission data
                            const summary = {
                                totalTransmissions: transmissions.length,
                                totalTransactions: transmissions.reduce((sum, tx) => sum + tx.transactionCount, 0),
                                totalAmountDebit: transmissions.reduce((sum, tx) => sum + parseInt(tx.totalAmountDebit), 0),
                                totalAmountCredit: transmissions.reduce((sum, tx) => sum + parseInt(tx.totalAmountCredit), 0)
                            };
                            
                            resolve({
                                success: true,
                                transmissions: transmissions,
                                summary: summary,
                                message: response.userMessage[0]
                            });
                        } else {
                            resolve({
                                success: false,
                                errorCode: resultCode,
                                error: response.userMessage[0]
                            });
                        }
                    } else {
                        reject(new Error(`HTTP ${res.statusCode}: ${responseData}`));
                    }
                } catch (parseError) {
                    reject(new Error(`XML parsing failed: ${parseError.message}`));
                }
            });
        });
        
        req.on('error', (error) => {
            reject(error);
        });
        
        req.write(postData);
        req.end();
    });
}

// Example usage
async function example() {
    try {
        // Query specific transmission
        const result = await inquireTransmissions('0882819014', {
            transmitId: '987654321'
        });
        
        if (result.success) {
            console.log('Transmission inquiry successful!');
            console.log(`Found ${result.summary.totalTransmissions || 0} transmissions`);
            
            result.transmissions.forEach((transmission, index) => {
                console.log(`Transmission ${index + 1}:`);
                console.log(`  ID: ${transmission.transmitId}`);
                console.log(`  Status: ${transmission.transmitStatus}`);
                console.log(`  Type: ${transmission.transmitType}`);
                console.log(`  Transaction Count: ${transmission.transactionCount}`);
                console.log(`  Start Time: ${transmission.startDateTime}`);
                console.log(`  End Time: ${transmission.endDateTime}`);
                console.log(`  Shva Reference: ${transmission.shvaReferanceNo}`);
                console.log(`  Debit Amount: ${transmission.totalAmountDebit}`);
                console.log(`  Credit Amount: ${transmission.totalAmountCredit}`);
                console.log('---');
            });
        } else {
            console.log(`Transmission inquiry failed: ${result.error}`);
        }
        
        // Query transmissions by date range
        const dateResult = await inquireTransmissions('0882819014', {
            fromDateTime: '2025-07-24 08:00:00',
            toDateTime: '2025-07-24 23:59:59'
        });
        
        if (dateResult.success) {
            console.log(`Date range inquiry found ${dateResult.transmissions.length} transmissions`);
            const totalTransactions = dateResult.transmissions.reduce((sum, tx) => sum + tx.transactionCount, 0);
            console.log(`Total transactions transmitted: ${totalTransactions}`);
        } else {
            console.log(`Date range inquiry failed: ${dateResult.error}`);
        }
        
    } catch (error) {
        console.error('Operation failed:', error.message);
    }
}

example();

Error codes

Error Code

Description

Resolution

000

Permitted transaction

Transmission inquiry completed successfully

308

An error occurred while executing a query in the database

Contact System Administration

444

Application Error

Contact System Administration

500

transmitId was not found

Verify the transmission ID exists and is valid

501

Terminal cannot be retransmitted

Call support for assistance

502

Terminal is currently in transmit

Wait for current transmission to complete before retrying

503

Terminal cannot be retransmitted

There was no transmit failure - retransmission not needed

504

Cannot transmit

There was a transmit failure - please try to retransmit

534

Transmit exceeds allowed batches per transmit

Contact System Administration

550

transmit service, error parsing GW request

Contact System Administration

552

transmit service, transmit_log not in status 0

Contact System Administration

553

transmit service, error getting transactions from DB

Contact System Administration

554

transmit service, error creating transactionData

Contact System Administration

555

transmit service, error creating 1402 messages

Contact System Administration

556

transmit service, error sending or creating request to BP

Contact System Administration

557

transmit service, error updating transmit log

Contact System Administration

558

Acquirer error - terminal does not exist

Contact System Administration

transmitTerminal - Manually initiate transmissions (use transmitInquire to verify results)
doDeal - Process transactions that are later transmitted
Request Structure - General API request format

Reconciliation Tip: Use transmitInquire in combination with inquireTransactions to get a complete picture of your settlement process - transmission status from transmitInquire and individual transaction details from inquireTransactions.

Data Retention: Transmission records may have retention limits. For long-term reconciliation, consider extracting and storing transmission data in your own systems.

PreviousrefundDeal NexttransmitTerminal

Last updated 3 months ago

Was this helpful?

Good afternoon

Overview

Use cases

Request structure

XML payload structure

Required parameters

Optional parameters

Response structure

Successful response example

Error response example

Code examples

Error codes

Related commands