{"_id":"5632a5eb49e16d0d001224b6","user":"55b932ba8fd1a02b00f496c8","category":{"_id":"5632a5e749e16d0d00122446","project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","__v":1,"pages":["5632a5eb49e16d0d001224b3","5632a5eb49e16d0d001224b4","5632a5eb49e16d0d001224b5","5632a5eb49e16d0d001224b6","5632a5eb49e16d0d001224b7","5632a5eb49e16d0d001224b8","5632a5eb49e16d0d001224b9","5632a5eb49e16d0d001224ba","5632a5eb49e16d0d001224bb","5632a5eb49e16d0d001224bc"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-03T17:59:48.628Z","from_sync":false,"order":4,"slug":"receipts","title":"Receipts"},"version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"__v":0,"githubsync":"","project":"55b933b3146ef121002158d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:01:07.445Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Retrieve a receipt for a transaction\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to render a receipt template for a given transaction.\nRefNum referers to the gateway assigned transaction identifier. ReceiptName refers to the name of the receipt. ContentType refers to the type of receipt requested.\nReturns base64 encode receipt. If an error occurs, an exception will be thrown.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nstring **renderReceiptByName **( [ueSecurityToken](/docs/uesecuritytoken), RefNum, ReceiptName, ContentType )\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Arguments\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"[ueSecurityToken](/docs/uesecuritytoken)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and retrieve the custom fields.\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"RefNum\",\n    \"1-2\": \"Gateway assigned transaction ID\",\n    \"2-0\": \"string\",\n    \"2-1\": \"ReceiptName\",\n    \"2-2\": \"Name of receipt to render\",\n    \"3-0\": \"string\",\n    \"3-1\": \"ContentType\",\n    \"3-2\": \"Format of receipt (HTML or Text)\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"string\",\n    \"0-1\": \"Returns base64 encoded receipt\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exceptions\"\n}\n[/block]\nThe following exceptions (errors) are applicable to this method.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Message\",\n    \"h-2\": \"Advice\",\n    \"0-0\": \"20001\",\n    \"0-1\": \"Specified transactions was not found\",\n    \"0-2\": \"Specified RefNum does not match a transaction for this merchant.\",\n    \"1-0\": \"20030\",\n    \"1-1\": \"Requested receipt not found\",\n    \"1-2\": \"ReceiptRefNum must match an existing receipt.\",\n    \"2-0\": \"20031\",\n    \"2-1\": \"Invalid content type\",\n    \"2-2\": \"ContentType must be either Text, HTML or Both\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\ntry {\\n $ReceiptName = \\\"mycartreceipt;\\n $RefNum = 1102910;\\n $receipt = $client->renderReceiptByName($token, $RefNum, $ReceiptName, \\\"HTML\\\");\\n $receipt = base64_decode($receipt);\\n}\\ncatch(SoapFault $e) {\\n echo $e->getMessage();\\n}\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n##Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim receiptName As String\\n       receiptName = \\\"test receipt\\\"\\n       Dim refNum As String\\n       refNum = \\\"46981789\\\"\\n       Dim contentType As String\\n       contentType = \\\"text\\\"\\n       Dim response As String\\n       response = client.renderReceiptByName(token, refNum, receiptName, contentType)\\n       Dim todecode As Byte()\\n       todecode = Convert.FromBase64String(response)\\n       MsgBox(System.Text.Encoding.UTF8.GetString(todecode))\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string refNum = \\\"46981789\\\";\\n           string receiptName = \\\"test receipt\\\";\\n           string ContentType = \\\"text\\\";\\n           string response;\\n           try\\n           {\\n               response = client.renderReceiptByName(token, refNum, receiptName, ContentType);\\n               byte[] todecode = Convert.FromBase64String(response);\\n               MessageBox.Show(string.Concat(System.Text.Encoding.UTF8.GetString(todecode)));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n\nRequest:\nResponse:","excerpt":"","slug":"renderreceiptbyname","type":"basic","title":"renderReceiptByName"}

renderReceiptByName


Retrieve a receipt for a transaction [block:api-header] { "type": "basic", "title": "Description" } [/block] 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. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] string **renderReceiptByName **( [ueSecurityToken](/docs/uesecuritytoken), RefNum, ReceiptName, ContentType ) [block:api-header] { "type": "basic", "title": "Arguments" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "[ueSecurityToken](/docs/uesecuritytoken)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and retrieve the custom fields.", "1-0": "integer", "1-1": "RefNum", "1-2": "Gateway assigned transaction ID", "2-0": "string", "2-1": "ReceiptName", "2-2": "Name of receipt to render", "3-0": "string", "3-1": "ContentType", "3-2": "Format of receipt (HTML or Text)" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "string", "0-1": "Returns base64 encoded receipt" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Exceptions" } [/block] The following exceptions (errors) are applicable to this method. [block:parameters] { "data": { "h-0": "Code", "h-1": "Message", "h-2": "Advice", "0-0": "20001", "0-1": "Specified transactions was not found", "0-2": "Specified RefNum does not match a transaction for this merchant.", "1-0": "20030", "1-1": "Requested receipt not found", "1-2": "ReceiptRefNum must match an existing receipt.", "2-0": "20031", "2-1": "Invalid content type", "2-2": "ContentType must be either Text, HTML or Both" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $ReceiptName = \"mycartreceipt;\n $RefNum = 1102910;\n $receipt = $client->renderReceiptByName($token, $RefNum, $ReceiptName, \"HTML\");\n $receipt = base64_decode($receipt);\n}\ncatch(SoapFault $e) {\n echo $e->getMessage();\n}\n?>", "language": "php" } ] } [/block] ##Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim receiptName As String\n receiptName = \"test receipt\"\n Dim refNum As String\n refNum = \"46981789\"\n Dim contentType As String\n contentType = \"text\"\n Dim response As String\n response = client.renderReceiptByName(token, refNum, receiptName, contentType)\n Dim todecode As Byte()\n todecode = Convert.FromBase64String(response)\n MsgBox(System.Text.Encoding.UTF8.GetString(todecode))", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string refNum = \"46981789\";\n string receiptName = \"test receipt\";\n string ContentType = \"text\";\n string response;\n try\n {\n response = client.renderReceiptByName(token, refNum, receiptName, ContentType);\n byte[] todecode = Convert.FromBase64String(response);\n MessageBox.Show(string.Concat(System.Text.Encoding.UTF8.GetString(todecode)));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block] ## XML Request: Response: