emailTransactionReceiptByName

Emails a new receipt for an existing transaction. Selects receipt by name.

This method allows you to email a new receipt for a existing transaction. This requires a receipt reference name, a transaction reference number and a valid email address. Transaction reference numbers can be found in the transactionResponse or retrieved with searchTransactionsCustom. The receipt name is assigned by the user when a custom receipt is created. Here are the receipt names for the system default receipts:

• vterm -Virtual Terminal (Printed)
• vterm_merchant -Virtual Terminal (Merchant Email)
• vterm_customer -Virtual Terminal (Customer Email)
• saleform_merchant -Sale Form (Merchant Email)
• saleform_customer -Sale Form (Customer Email)
• tranapi -Transaction API and Payment Form (Merchant)
• tranapi_customer -Transaction API and Payment Form (Customer)

See also addReceipt, updateReceipt, getReceipt, emailTransactionReceipt

boolean emailTransactionReceiptByName ( ueSecurityToken, TransactionRefNum, ReceiptName, EmailAddress)

The following exceptions (errors) are applicable to this method.

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

<?php 
 
try {
 
  $TransactionRefNum=123456789; 	
  $sent = $this->client->emailTransactionReceiptByName($this->token, $RefNum, 'tranapi', 'email@address.com');;
 
} 
 
catch(SoapFault $e) { 
 
  echo $e->getMessage(); 
 
} 
 
?> 

Dim refnum As String
        refnum = "46973419"
 
        Dim result As Boolean
        result = client.emailTransactionReceiptByName(token, refnum, "recurring", "email@mycompany.com")
        MsgBox(result)

For directions on how to set up the WSDL link and create the “token” and “client” variables, go to the C Sharp .Net Soap How-to.

string refnum;
            refnum = "46973419";
 
            Boolean result;
 
            try
            {
                result = client.emailTransactionReceiptByName(token, refnum, "recurring", "email@yourdomain.com");
                if (result)
                {
                    MessageBox.Show(string.Concat("Email is sent"));
                }
                else MessageBox.Show("Error");
            }
 
 
            catch (Exception err)
            {
                MessageBox.Show(err.Message);
            }

Request:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
 xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:ns1="urn:usaepay"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
 SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:emailTransactionReceiptByName>
 <Token xsi:type="ns1:ueSecurityToken">
  <ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>
  <PinHash xsi:type="ns1:ueHash">
   <HashValue xsi:type="xsd:string">491cf3d49644e80b7d854268fe0b1b39cbfa1e92</HashValue>
   <Seed xsi:type="xsd:string">1267817706259452304</Seed>
   <Type xsi:type="xsd:string">sha1</Type>
  </PinHash>
  <SourceKey xsi:type="xsd:string">1B93L5cpXV5hbx557d183q96EZ2jpqEf</SourceKey>
 </Token>
 <RefNum xsi:type="xsd:integer">1335780</RefNum>
 <ReceiptName xsi:type="xsd:string">tranapi</ReceiptName>
 <Email xsi:type="xsd:string">email@address.com</Email>
</ns1:emailTransactionReceiptByName>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
 xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:ns1="urn:usaepay"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
 SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:emailTransactionReceiptByNameResponse>
 <emailTransactionReceiptByNameReturn xsi:type="xsd:boolean">true</emailTransactionReceiptByNameReturn>
</ns1:emailTransactionReceiptByNameResponse>
</SOAP-ENV:Body></SOAP-ENV:Envelope>