GetBatchTransactions
Description
The GetBatchTransactions method retrieves all transactions associated with a batch.
Syntax
TransactionObject[] GetBatchTransaction(SecurityToken securityToken, string batchId)
Arguments
Type | Name | Description | |
|---|---|---|---|
securityToken | R | A unique token that is used to identify a merchant and authenticate the API request. | |
string | batchId | R | Identifies the batch to retrieve. Note: This value is identical to |
Return Value
| Type | Description |
|---|---|
| TransactionObject[] | On success, returns the requested batch containing all transactions. Otherwise, a fault is returned. |
Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
<soapenv:Header/>
<soapenv:Body>
<ebiz:GetBatchTransactions>
<ebiz:securityToken>
<ebiz:SecurityId>***********621-b899-9301********</ebiz:SecurityId>
<ebiz:UserId/>
<ebiz:Password/>
</ebiz:securityToken>
<ebiz:batchId>***276</ebiz:batchId>
</ebiz:GetBatchTransactions>
</soapenv:Body>
</soapenv:Envelope>private static void GetBatchTransactions()
{
IeBizService apiClient = new IeBizServiceClient();
SecurityToken securityToken = new SecurityToken()
{
SecurityId = "*************-4970-ba92-************",
UserId = "",
Password = ""
};
string batchId = "0";
TransactionObject[] batchTransactions = apiClient.GetBatchTransactions(securityToken, batchId);
foreach (var transaction in batchTransactions)
{
Console.WriteLine("===== Transaction =====");
Console.WriteLine($"DateTime: {transaction.DateTime}");
Console.WriteLine($"Source: {transaction.Source}");
Console.WriteLine($"ServerIP: {transaction.ServerIP}");
Console.WriteLine($"User: {transaction.User}");
Console.WriteLine($"CustomerID: {transaction.CustomerID}");
Console.WriteLine($"AccountHolder: {transaction.AccountHolder}");
Console.WriteLine($"Status: {transaction.Status}");
Console.WriteLine($"TransactionType: {transaction.TransactionType}");
// ShippingAddress
var shippingAddress = transaction.ShippingAddress;
if (shippingAddress != null)
{
Console.WriteLine("--- ShippingAddress ---");
Console.WriteLine($"City: {shippingAddress.City}");
Console.WriteLine($"Company: {shippingAddress.Company}");
Console.WriteLine($"Country: {shippingAddress.Country}");
Console.WriteLine($"Email: {shippingAddress.Email}");
Console.WriteLine($"Fax: {shippingAddress.Fax}");
Console.WriteLine($"FirstName: {shippingAddress.FirstName}");
Console.WriteLine($"LastName: {shippingAddress.LastName}");
Console.WriteLine($"Phone: {shippingAddress.Phone}");
Console.WriteLine($"State: {shippingAddress.State}");
Console.WriteLine($"Street: {shippingAddress.Street}");
Console.WriteLine($"Street2: {shippingAddress.Street2}");
Console.WriteLine($"Zip: {shippingAddress.Zip}");
}
// BillingAddress
var billingAddress = transaction.BillingAddress;
if (billingAddress != null)
{
Console.WriteLine("--- BillingAddress ---");
Console.WriteLine($"City: {billingAddress.City}");
Console.WriteLine($"Company: {billingAddress.Company}");
Console.WriteLine($"Country: {billingAddress.Country}");
Console.WriteLine($"Email: {billingAddress.Email}");
Console.WriteLine($"Fax: {billingAddress.Fax}");
Console.WriteLine($"FirstName: {billingAddress.FirstName}");
Console.WriteLine($"LastName: {billingAddress.LastName}");
Console.WriteLine($"Phone: {billingAddress.Phone}");
Console.WriteLine($"State: {billingAddress.State}");
Console.WriteLine($"Street: {billingAddress.Street}");
Console.WriteLine($"Street2: {billingAddress.Street2}");
Console.WriteLine($"Zip: {billingAddress.Zip}");
}
// Response block
var response = transaction.Response;
if (response != null)
{
Console.WriteLine("--- Response ---");
Console.WriteLine($"CustNum: {response.CustNum}");
Console.WriteLine($"ResultCode: {response.ResultCode}");
Console.WriteLine($"Result: {response.Result}");
Console.WriteLine($"RemainingBalance: {response.RemainingBalance}");
Console.WriteLine($"RefNum: {response.RefNum}");
Console.WriteLine($"isDuplicate: {response.isDuplicate}");
Console.WriteLine($"ErrorCode: {response.ErrorCode}");
Console.WriteLine($"Error: {response.Error}");
Console.WriteLine($"ConvertedAmount: {response.ConvertedAmount}");
Console.WriteLine($"ConversionRate: {response.ConversionRate}");
Console.WriteLine($"CardCodeResultCode: {response.CardCodeResultCode}");
Console.WriteLine($"CardCodeResult: {response.CardCodeResult}");
Console.WriteLine($"BatchRefNum: {response.BatchRefNum}");
Console.WriteLine($"BatchNum: {response.BatchNum}");
Console.WriteLine($"AvsResultCode: {response.AvsResultCode}");
Console.WriteLine($"AvsResult: {response.AvsResult}");
Console.WriteLine($"AuthCode: {response.AuthCode}");
Console.WriteLine($"AuthAmount: {response.AuthAmount}");
Console.WriteLine($"Status: {response.Status}");
Console.WriteLine($"StatusCode: {response.StatusCode}");
}
// Details block
var details = transaction.Details;
if (details != null)
{
Console.WriteLine("--- Details ---");
Console.WriteLine($"NonTax: {details.NonTax}");
Console.WriteLine($"Tax: {details.Tax}");
Console.WriteLine($"Subtotal: {details.Subtotal}");
Console.WriteLine($"Shipping: {details.Shipping}");
Console.WriteLine($"PONum: {details.PONum}");
Console.WriteLine($"OrderID: {details.OrderID}");
Console.WriteLine($"Invoice: {details.Invoice}");
Console.WriteLine($"Duty: {details.Duty}");
Console.WriteLine($"Discount: {details.Discount}");
Console.WriteLine($"Description: {details.Description}");
Console.WriteLine($"Clerk: {details.Clerk}");
Console.WriteLine($"Amount: {details.Amount}");
Console.WriteLine($"AllowPartialAuth:{details.AllowPartialAuth}");
Console.WriteLine($"Terminal: {details.Terminal}");
Console.WriteLine($"Tip: {details.Tip}");
}
// CreditCardData block
var cc = transaction.CreditCardData;
if (cc != null)
{
Console.WriteLine("--- CreditCardData ---");
Console.WriteLine($"CardType: {cc.CardType}");
Console.WriteLine($"CardPresent: {cc.CardPresent}");
Console.WriteLine($"CardNumber: {cc.CardNumber}");
Console.WriteLine($"CardExpiration: {cc.CardExpiration}");
Console.WriteLine($"CardCode: {cc.CardCode}");
Console.WriteLine($"AvsZip: {cc.AvsZip}");
Console.WriteLine($"AvsStreet: {cc.AvsStreet}");
}
Console.WriteLine("=========================");
Console.WriteLine();
}
}// Initialize the SOAP client (replace with your actual endpoint URL)
$client = new SoapClient("https://ebizsoapapidev1.ebizcharge.net/eBizService.svc?singleWsdl");
// Define the merchant security token
$securityToken = array(
'SecurityId' => '*************-4970-ba92-************' // Replace with your actual token
);
// Define parameters for GetBatchTransactions
$batchId = "0"; // Not used in this example
// Prepare parameters for the SOAP request
$params = array(
'securityToken' => $securityToken,
'batchId' => $batchId
);
try {
// Make the SOAP request
$response = $client->GetBatchTransactions($params);
// Extract result object from response
if (!isset($response->GetBatchTransactionsResult)) {
echo "No GetBatchTransactionsResult in response.\n";
exit;
}
$result = $response->GetBatchTransactionsResult;
// The result should contain one or more TransactionObject item $result->TransactionObject
$transactions = array();
if (isset($result->TransactionObject)) {
$transactions = $result->TransactionObject;
}
// Normalize to array
if (!is_array($transactions)) {
$transactions = $transactions ? array($transactions) : array();
}
if (count($transactions) === 0) {
echo "No transactions returned for this batch.\n";
exit;
}
foreach ($transactions as $i => $txn) {
echo "===== Transaction #" . ($i + 1) . " =====\n";
echo "DateTime: " . ($txn->DateTime ?? '') . "\n";
echo "Source: " . ($txn->Source ?? '') . "\n";
echo "ServerIP: " . ($txn->ServerIP ?? '') . "\n";
echo "User: " . ($txn->User ?? '') . "\n";
echo "CustomerID: " . ($txn->CustomerID ?? '') . "\n";
echo "AccountHolder: " . ($txn->AccountHolder ?? '') . "\n";
echo "Status: " . ($txn->Status ?? '') . "\n";
echo "TransactionType: " . ($txn->TransactionType ?? '') . "\n";
// ShippingAddress
if (isset($txn->ShippingAddress)) {
$sa = $txn->ShippingAddress;
echo "--- ShippingAddress ---\n";
echo "City: " . ($sa->City ?? '') . "\n";
echo "Company: " . ($sa->Company ?? '') . "\n";
echo "Country: " . ($sa->Country ?? '') . "\n";
echo "Email: " . ($sa->Email ?? '') . "\n";
echo "Fax: " . ($sa->Fax ?? '') . "\n";
echo "FirstName: " . ($sa->FirstName ?? '') . "\n";
echo "LastName: " . ($sa->LastName ?? '') . "\n";
echo "Phone: " . ($sa->Phone ?? '') . "\n";
echo "State: " . ($sa->State ?? '') . "\n";
echo "Street: " . ($sa->Street ?? '') . "\n";
echo "Street2: " . ($sa->Street2 ?? '') . "\n";
echo "Zip: " . ($sa->Zip ?? '') . "\n";
}
// BillingAddress
if (isset($txn->BillingAddress)) {
$ba = $txn->BillingAddress;
echo "--- BillingAddress ---\n";
echo "City: " . ($ba->City ?? '') . "\n";
echo "Company: " . ($ba->Company ?? '') . "\n";
echo "Country: " . ($ba->Country ?? '') . "\n";
echo "Email: " . ($ba->Email ?? '') . "\n";
echo "Fax: " . ($ba->Fax ?? '') . "\n";
echo "FirstName: " . ($ba->FirstName ?? '') . "\n";
echo "LastName: " . ($ba->LastName ?? '') . "\n";
echo "Phone: " . ($ba->Phone ?? '') . "\n";
echo "State: " . ($ba->State ?? '') . "\n";
echo "Street: " . ($ba->Street ?? '') . "\n";
echo "Street2: " . ($ba->Street2 ?? '') . "\n";
echo "Zip: " . ($ba->Zip ?? '') . "\n";
}
// Response
if (isset($txn->Response)) {
$r = $txn->Response;
echo "--- Response ---\n";
echo "CustNum: " . ($r->CustNum ?? '') . "\n";
echo "ResultCode: " . ($r->ResultCode ?? '') . "\n";
echo "Result: " . ($r->Result ?? '') . "\n";
echo "RemainingBalance: " . ($r->RemainingBalance ?? '') . "\n";
echo "RefNum: " . ($r->RefNum ?? '') . "\n";
echo "isDuplicate: " . (isset($r->isDuplicate) ? ($r->isDuplicate ? 'true' : 'false') : '') . "\n";
echo "ErrorCode: " . ($r->ErrorCode ?? '') . "\n";
echo "Error: " . ($r->Error ?? '') . "\n";
echo "ConvertedAmount: " . ($r->ConvertedAmount ?? '') . "\n";
echo "ConversionRate: " . ($r->ConversionRate ?? '') . "\n";
echo "CardCodeResultCode:" . ($r->CardCodeResultCode ?? '') . "\n";
echo "CardCodeResult: " . ($r->CardCodeResult ?? '') . "\n";
echo "BatchRefNum: " . ($r->BatchRefNum ?? '') . "\n";
echo "BatchNum: " . ($r->BatchNum ?? '') . "\n";
echo "AvsResultCode: " . ($r->AvsResultCode ?? '') . "\n";
echo "AvsResult: " . ($r->AvsResult ?? '') . "\n";
echo "AuthCode: " . ($r->AuthCode ?? '') . "\n";
echo "AuthAmount: " . ($r->AuthAmount ?? '') . "\n";
echo "Status: " . ($r->Status ?? '') . "\n";
echo "StatusCode: " . ($r->StatusCode ?? '') . "\n";
}
// Details
if (isset($txn->Details)) {
$d = $txn->Details;
echo "--- Details ---\n";
echo "NonTax: " . (isset($d->NonTax) ? ($d->NonTax ? 'true' : 'false') : '') . "\n";
echo "Tax: " . ($d->Tax ?? '') . "\n";
echo "Subtotal: " . ($d->Subtotal ?? '') . "\n";
echo "Shipping: " . ($d->Shipping ?? '') . "\n";
echo "PONum: " . ($d->PONum ?? '') . "\n";
echo "OrderID: " . ($d->OrderID ?? '') . "\n";
echo "Invoice: " . ($d->Invoice ?? '') . "\n";
echo "Duty: " . ($d->Duty ?? '') . "\n";
echo "Discount: " . ($d->Discount ?? '') . "\n";
echo "Description: " . ($d->Description ?? '') . "\n";
echo "Clerk: " . ($d->Clerk ?? '') . "\n";
echo "Amount: " . ($d->Amount ?? '') . "\n";
echo "AllowPartialAuth: " . (isset($d->AllowPartialAuth) ? ($d->AllowPartialAuth ? 'true' : 'false') : '') . "\n";
echo "Terminal: " . ($d->Terminal ?? '') . "\n";
echo "Tip: " . ($d->Tip ?? '') . "\n";
}
// CreditCardData
if (isset($txn->CreditCardData)) {
$cc = $txn->CreditCardData;
echo "--- CreditCardData ---\n";
echo "CardType: " . ($cc->CardType ?? '') . "\n";
echo "CardPresent: " . (isset($cc->CardPresent) ? ($cc->CardPresent ? 'true' : 'false') : '') . "\n";
echo "CardNumber: " . ($cc->CardNumber ?? '') . "\n";
echo "CardExpiration:" . ($cc->CardExpiration ?? '') . "\n";
echo "CardCode: " . ($cc->CardCode ?? '') . "\n";
echo "AvsZip: " . ($cc->AvsZip ?? '') . "\n";
echo "AvsStreet: " . ($cc->AvsStreet ?? '') . "\n";
}
echo "============================\n\n";
}
} catch (SoapFault $e) {
echo "SOAP Error: " . $e->getMessage() . "\n";
}Example Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetBatchTransactionsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<GetBatchTransactionsResult>
<TransactionObject>
<DateTime>2025-10-20 13:50:48</DateTime>
<Source>api</Source>
<ShippingAddress>
<City>Irvine</City>
<Company>CBS</Company>
<Country/>
<Email/>
<Fax/>
<FirstName>Tim</FirstName>
<LastName>Rogers</LastName>
<Phone/>
<State>CA</State>
<Street>55 Golden</Street>
<Street2/>
<Zip>92618</Zip>
</ShippingAddress>
<ServerIP>20.14.118.41</ServerIP>
<Response>
<CustNum>0</CustNum>
<ResultCode>A</ResultCode>
<Result>Approved</Result>
<RemainingBalance>0</RemainingBalance>
<RefNum>******8336</RefNum>
<isDuplicate>false</isDuplicate>
<ErrorCode>0</ErrorCode>
<Error>Approved</Error>
<ConvertedAmountCurrency/>
<ConvertedAmount>0</ConvertedAmount>
<ConversionRate>0</ConversionRate>
<CardCodeResultCode>M</CardCodeResultCode>
<CardCodeResult>Match</CardCodeResult>
<BatchRefNum>***276</BatchRefNum>
<BatchNum>1</BatchNum>
<AvsResultCode>YYY</AvsResultCode>
<AvsResult>Address: Match & 5 Digit Zip: Match</AvsResult>
<AuthCode>***369</AuthCode>
<AuthAmount>100.25</AuthAmount>
<Status>Pending</Status>
<StatusCode>P</StatusCode>
</Response>
<LineItems>
<LineItem>
<DiscountRate>0.000</DiscountRate>
<SKU>BN-434e-8f3c</SKU>
<CommodityCode>100001</CommodityCode>
<ProductName>Sony TV</ProductName>
<Description>Sony TV</Description>
<DiscountAmount>0.00</DiscountAmount>
<TaxRate>0.000</TaxRate>
<UnitOfMeasure>EA</UnitOfMeasure>
<UnitPrice>1000.00</UnitPrice>
<Qty>1.0000</Qty>
<Taxable>true</Taxable>
<TaxAmount>0.00</TaxAmount>
</LineItem>
</LineItems>
<Details>
<NonTax>false</NonTax>
<Tax>10</Tax>
<Table/>
<Subtotal>0</Subtotal>
<Shipping>10.25</Shipping>
<ShipFromZip>92618</ShipFromZip>
<PONum>Po12300</PONum>
<OrderID>O0001</OrderID>
<Invoice>Inv0001</Invoice>
<Duty>0</Duty>
<Discount>920</Discount>
<Comments/>
<Description>This is the description</Description>
<Currency/>
<Clerk>User1</Clerk>
<Amount>100.25</Amount>
<AllowPartialAuth>false</AllowPartialAuth>
<Terminal>Terminal1</Terminal>
<Tip>0</Tip>
</Details>
<User>auto</User>
<CustomFields/>
<CustomerID>Cbs0001</CustomerID>
<CreditCardData>
<Pares/>
<MagSupport/>
<MagStripe/>
<InternalCardAuth>false</InternalCardAuth>
<CardType>V</CardType>
<CardPresent>false</CardPresent>
<CardNumber>XXXXXXXXXXXX2224</CardNumber>
<CardExpiration>XXXX</CardExpiration>
<CardCode>XXX</CardCode>
<AvsZip>92618</AvsZip>
<AvsStreet>20 Pacifica</AvsStreet>
<TermType/>
</CreditCardData>
<ClientIP/>
<CheckTrace/>
<CheckData/>
<BillingAddress>
<City>Irvine</City>
<Company>CBS</Company>
<Country/>
<Email/>
<Fax/>
<FirstName>User</FirstName>
<LastName>User</LastName>
<Phone/>
<State>CA</State>
<Street>20 Pacifica</Street>
<Street2/>
<Zip>92618</Zip>
</BillingAddress>
<AccountHolder>User</AccountHolder>
<Status>Voided</Status>
<TransactionType>Voided Sale</TransactionType>
</TransactionObject>
<TransactionObject>
<DateTime>2025-12-13 02:20:01</DateTime>
<Source>recurring payments</Source>
<ShippingAddress>
<City/>
<Company/>
<Country/>
<Email/>
<Fax/>
<FirstName/>
<LastName/>
<Phone/>
<State/>
<Street/>
<Street2/>
<Zip/>
</ShippingAddress>
<ServerIP>20.14.118.41</ServerIP>
<Response>
<CustNum>19646130</CustNum>
<ResultCode>A</ResultCode>
<Result>Approved</Result>
<RemainingBalance>0</RemainingBalance>
<RefNum>******8127</RefNum>
<isDuplicate>false</isDuplicate>
<ErrorCode>0</ErrorCode>
<Error>Approved</Error>
<ConvertedAmountCurrency/>
<ConvertedAmount>0</ConvertedAmount>
<ConversionRate>0</ConversionRate>
<CardCodeResultCode>M</CardCodeResultCode>
<CardCodeResult>Match</CardCodeResult>
<BatchRefNum>***276</BatchRefNum>
<BatchNum>1</BatchNum>
<AvsResultCode>YYY</AvsResultCode>
<AvsResult>Address: Match & 5 Digit Zip: Match</AvsResult>
<AuthCode>***023</AuthCode>
<AuthAmount>1000</AuthAmount>
<Status>Pending</Status>
<StatusCode>P</StatusCode>
</Response>
<LineItems>
<LineItem>
<DiscountRate>0.000</DiscountRate>
<SKU>BX-439c-b500</SKU>
<CommodityCode>100001</CommodityCode>
<ProductName>Inv# Inv</ProductName>
<Description>Inv# Inv</Description>
<DiscountAmount>0.00</DiscountAmount>
<TaxRate>0.000</TaxRate>
<UnitOfMeasure>EA</UnitOfMeasure>
<UnitPrice>1000.00</UnitPrice>
<Qty>1.0000</Qty>
<Taxable>false</Taxable>
<TaxAmount>0.00</TaxAmount>
</LineItem>
</LineItems>
<Details>
<NonTax>false</NonTax>
<Tax>0</Tax>
<Table/>
<Subtotal>0</Subtotal>
<Shipping>0</Shipping>
<ShipFromZip>92618</ShipFromZip>
<PONum>Recurring</PONum>
<OrderID>Recurring</OrderID>
<Invoice>Recurring</Invoice>
<Duty>0</Duty>
<Discount>0</Discount>
<Comments/>
<Description>Monthly billing</Description>
<Currency/>
<Clerk>recurring</Clerk>
<Amount>1000</Amount>
<AllowPartialAuth>false</AllowPartialAuth>
<Terminal>EBizCharge Portal</Terminal>
<Tip>0</Tip>
</Details>
<User/>
<CustomFields/>
<CustomerID>testing-1</CustomerID>
<CreditCardData>
<Pares/>
<MagSupport/>
<MagStripe/>
<InternalCardAuth>false</InternalCardAuth>
<CardType>V</CardType>
<CardPresent>false</CardPresent>
<CardNumber>XXXXXXXXXXXX2224</CardNumber>
<CardExpiration>XXXX</CardExpiration>
<CardCode>XXX</CardCode>
<AvsZip>90046</AvsZip>
<AvsStreet>123 Main st.</AvsStreet>
<TermType/>
</CreditCardData>
<ClientIP>10.70.64.15</ClientIP>
<CheckTrace/>
<CheckData/>
<BillingAddress>
<City>Abyss</City>
<Company>CBS</Company>
<Country/>
<Email>[email protected]</Email>
<Fax/>
<FirstName>Will</FirstName>
<LastName>Smith</LastName>
<Phone>1234567789</Phone>
<State>CA</State>
<Street>50 Golden</Street>
<Street2>r</Street2>
<Zip>56789</Zip>
</BillingAddress>
<AccountHolder>test</AccountHolder>
<Status>Authorized (Pending Settlement)</Status>
<TransactionType>Sale</TransactionType>
</TransactionObject>
</GetBatchTransactionsResult>
</GetBatchTransactionsResponse>
</s:Body>
</s:Envelope><s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<s:Fault>
<faultcode>s:Error</faultcode>
<faultstring xml:lang="en-US">Error: 40027: Unable to find requested batch.</faultstring>
</s:Fault>
</s:Body>
</s:Envelope>Updated 4 months ago
