`python 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"""
2000
Eng
transmitInquire
{terminal_number}
{f'{transmit_id}' if transmit_id else ''}
{f'{from_datetime}' if from_datetime else ''}
{f'{to_datetime}' if to_datetime else ''}
{f'{shva_reference_no}' if shva_reference_no else ''}
"""
# 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 '',
'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']}")
```
`
`javascript const https = require('https'); const querystring = require('querystring'); const { parseStringPromise } = require('xml2js');
function inquireTransmissions(terminalNumber, options = {}) { return new Promise((resolve, reject) => { const serverUrl = '
'; const username = 'your\_username'; const password = 'your\_password';
```
// Build XML payload
let xmlPayload = `
2000
Eng
transmitInquire
${terminalNumber}`;
if (options.transmitId) {
xmlPayload += `${options.transmitId}`;
}
if (options.fromDateTime && options.toDateTime) {
xmlPayload += `${options.fromDateTime}`;
xmlPayload += `${options.toDateTime}`;
}
if (options.shvaReferenceNo) {
xmlPayload += `${options.shvaReferenceNo}`;
}
xmlPayload += `
`;
// 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] : '',
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(` 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();
```**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.
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://developers.hyp.co.il/enterprise/api-reference/transmitinquire.md?ask=