Retrieve a receipt for a transaction
This method allows you to render a receipt template for a given transaction.
RefNum referers to the gateway assigned transaction identifier. ReceiptName refers to the name of the receipt. ContentType refers to the type of receipt requested.
Returns base64 encode receipt. If an error occurs, an exception will be thrown.
See also renderReceipt
string renderReceiptByName ( ueSecurityToken, RefNum, ReceiptName, ContentType )
Type | Name | Description |
---|---|---|
ueSecurityToken | Token | Merchant security token: used to identify merchant and retrieve the custom fields. |
integer | RefNum | Gateway assigned transaction ID |
string | ReceiptName | Name of receipt to render |
string | ContentType | Format of receipt (HTML or Text) |
string | Returns base64 encoded receipt |
The following exceptions (errors) are applicable to this method.
Code | Message | Advice |
---|---|---|
20001 | Specified transactions was not found | Specified RefNum does not match a transaction for this merchant. |
20030 | Requested receipt not found | ReceiptRefNum must match an existing receipt. |
20031 | Invalid content type | ContentType must be either Text, HTML or Both |
For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.
<?php try { $ReceiptName = "mycartreceipt; $RefNum = 1102910; $receipt = $client->renderReceiptByName($token, $RefNum, $ReceiptName, "HTML"); $receipt = base64_decode($receipt); } catch(SoapFault $e) { echo $e->getMessage(); } ?>
For directions on how to set up the WSDL link and create the “token” and “client” variables, go to the Visual Basic .Net Soap How-to.
Dim receiptName As String receiptName = "test receipt" Dim refNum As String refNum = "46981789" Dim contentType As String contentType = "text" Dim response As String response = client.renderReceiptByName(token, refNum, receiptName, contentType) Dim todecode As Byte() todecode = Convert.FromBase64String(response) MsgBox(System.Text.Encoding.UTF8.GetString(todecode))
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 = "46981789"; string receiptName = "test receipt"; string ContentType = "text"; string response; try { response = client.renderReceiptByName(token, refNum, receiptName, ContentType); byte[] todecode = Convert.FromBase64String(response); MessageBox.Show(string.Concat(System.Text.Encoding.UTF8.GetString(todecode))); } 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:renderReceiptByName> <Token xsi:type="ns1:ueSecurityToken"> <ClientIP xsi:type="xsd:string">123.123.123.123</ClientIP> <PinHash xsi:type="ns1:ueHash"> <HashValue xsi:type="xsd:string">f5210bf4381989eb937519891cacfa0afecde107</HashValue> <Seed xsi:type="xsd:string">11233279528-test</Seed> <Type xsi:type="xsd:string">sha1</Type> </PinHash> <SourceKey xsi:type="xsd:string">_B4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey> </Token> <RefNum xsi:type="xsd:integer">102302062</RefNum> <ReceiptName xsi:type="xsd:string">tranapi_customer</ReceiptName> <ContentType xsi:type="xsd:string">Text</ContentType> </ns1:renderReceiptByName> </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:renderReceiptByNameResponse> <renderReceiptByNameReturn xsi:type="xsd:string">WW91ciBjcmVkaXQgY2FyZCBwYXlt ZW50IGhhcyBiZWVuIHJlY2VpdmVkIGJ5IFhNTCBleGFtcGxlIGdlbmVyYXRvci4gQmVsb3cgaXMgD Qp5b3VyIHJlY2VpcHQgb2YgcGF5bWVudC4/DQoNClRyYW5zYWN0aW9uIERldGFpbHMNCi0tLS0tLS 0tLS0tLS0tLS0tLS0tLS0tDQpNZXJjaGFudDogICAgWE1MIGV4YW1wbGUgZ2VuZXJhdG9yDQpUeXB lOiAgICAgICAgQ3JlZGl0IENhcmQgU2FsZQ0KSW52b2ljZSAjOiAgIDEzMzY4MDg4MjMNCkFtb3Vu dDogICAgICAxMzIuODUNCkRlc2NyaXB0aW9uOiBFeGFtcGxlIFRyYW5zYWN0aW9uDQpDYXJkIEhvb GRlcjogVGVzdGVyIEpvbmVzDQpDYXJkIE51bWJlcjogeHh4eHh4eHh4eHh4eHg3Nzc5DQoNCg0KDQ oNCg0KDQp2OC4wMS11ZWdy</renderReceiptByNameReturn> </ns1:renderReceiptByNameResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Version | Change |
---|---|
1.3 | Method added in this release |