Guides
Guides
  1. Gateway Methods

GetReceiptsList

Description

The GetReceiptsList method retrieves receipt templates using the receiptType parameter. In the response, this value is represented as the Target field in the Receipt object.

Syntax

Receipt[] GetReceiptsList(SecurityToken securityToken, string receiptType)

Arguments

Type

Name

Req

Description

SecurityToken

securityToken

R

A unique token that is used to identify a merchant and authenticate the API request.

string

receiptType

O

Type of receipts to retrieve.

Note: Leave this field blank to return all types of receipt templates. In the Receipt object, this field is the Target field.

Possible Values
  • Email
  • Print

Return Value

TypeDescription
Receipt[]On success, returns an array of receipt templates. Otherwise, an empty array 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:GetReceiptsList>
         <ebiz:securityToken>
            <ebiz:SecurityId>*******-794B-4CEE-B4DF-********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:receiptType/>
      </ebiz:GetReceiptsList>
   </soapenv:Body>
</soapenv:Envelope>
private static void GetReceiptsList()
{
  IeBizService apiClient = new IeBizServiceClient();
  SecurityToken securityToken = new SecurityToken()
  {
    SecurityId = "*************-4970-ba92-************",
    UserId = "",
    Password = ""
    };
  string receiptType = "";
  Receipt[] receipt = apiClient.GetReceiptsList(securityToken, receiptType);
  foreach (var r in receipt)
  {
    Console.WriteLine("===== Receipt =====");
    Console.WriteLine($"ReceiptRefNum: {r.ReceiptRefNum}");
    Console.WriteLine($"Name:          {r.Name}");
    Console.WriteLine($"Subject:       {r.Subject}");
    Console.WriteLine($"FromEmail:     {r.FromEmail}");
    Console.WriteLine($"Target:        {r.Target}");
    Console.WriteLine($"ContentType:   {r.ContentType}");
    Console.WriteLine($"TemplateHTML:  {r.TemplateHTML}");
    Console.WriteLine($"TemplateText:  {r.TemplateText}");
    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
);

$receiptType = "";

// SOAP parameters
$params = array(
  'securityToken' => $securityToken,
  'receiptType'   => $receiptType,
);

try {
  $response = $client->GetReceiptsList($params);

  // Result is usually under GetReceiptsListResult
  if (!isset($response->GetReceiptsListResult)) {
    echo "No GetReceiptsListResult found.\n";
    // var_dump($response);
    exit;
  }

  $result = $response->GetReceiptsListResult;

  $receipts = $result;

  // If wrapped as Receipts->Receipt
  if (isset($result->Receipt)) {
    $receipts = $result->Receipt;
  } elseif (isset($result->Receipts)) {
    $receipts = $result->Receipts;
  }

  // Normalize to array
  if (!is_array($receipts)) {
    $receipts = $receipts ? array($receipts) : array();
  }

  if (count($receipts) === 0) {
    echo "No receipts returned.\n";
    exit;
  }

  foreach ($receipts as $i => $r) {
    echo "===== Receipt #" . ($i + 1) . " =====\n";
    echo "ReceiptRefNum: " . ($r->ReceiptRefNum ?? '') . "\n";
    echo "Name:          " . ($r->Name         ?? '') . "\n";
    echo "Subject:       " . ($r->Subject      ?? '') . "\n";
    echo "FromEmail:     " . ($r->FromEmail    ?? '') . "\n";
    echo "Target:        " . ($r->Target       ?? '') . "\n";
    echo "ContentType:   " . ($r->ContentType  ?? '') . "\n";
    echo "TemplateHTML:  " . ($r->TemplateHTML ?? '') . "\n";
    echo "TemplateText:  " . ($r->TemplateText ?? '') . "\n";
    echo "=========================\n\n";
  }

} catch (SoapFault $e) {
  // Handle any SOAP errors
  echo "SOAP Error: " . $e->getMessage();
}

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">
      <GetReceiptsListResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetReceiptsListResult>
            <Receipt>
               <ReceiptRefNum>9</ReceiptRefNum>
               <Name>Transaction API and Payment Form (Customer)</Name>
               <Subject>Customer Receipt</Subject>
               <FromEmail>[email protected]</FromEmail>
               <Target>email</Target>
               <ContentType>html</ContentType>
            </Receipt>
            <Receipt>
               <ReceiptRefNum>3</ReceiptRefNum>
               <Name>Transaction: Simple Pay, Open Credit, Voice Auth, ACH (Customer Email)</Name>
               <Subject>Customer Receipt</Subject>
               <FromEmail>[email protected]</FromEmail>
               <Target>email</Target>
               <ContentType>html</ContentType>
            </Receipt>
            <Receipt>
               <ReceiptRefNum>14</ReceiptRefNum>
               <Name>Transaction: Simple Pay, Open Credit, Voice Auth, ACH (Customer Email)</Name>
               <Subject>Customer Receipt</Subject>
               <FromEmail>[email protected]</FromEmail>
               <Target>email</Target>
               <ContentType>html</ContentType>
            </Receipt>
            <Receipt>
               <ReceiptRefNum>6</ReceiptRefNum>
               <Name>Transaction: Simple Pay, Open Credit, Voice Auth, ACH (Merchant Email)</Name>
               <Subject>Merchant Receipt</Subject>
               <FromEmail>[email protected]</FromEmail>
               <Target>email</Target>
               <ContentType>html</ContentType>
            </Receipt>
         </GetReceiptsListResult>
      </GetReceiptsListResponse>
   </s:Body>
</s:Envelope>
<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">
      <GetReceiptsListResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetReceiptsListResult/>
      </GetReceiptsListResponse>
   </s:Body>
</s:Envelope>

Updated 4 months ago