{"_id":"5632a5eb49e16d0d001224ba","user":"55b932ba8fd1a02b00f496c8","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","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"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:02:27.366Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"Retrieve a receipt template identified by Name.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to retrieve the receipt template identified by Name. This method will return the merchant's receipt template if it exists. Otherwise, if a system default template exists for “Name” it will be returned. If a system default is returned, the ReceiptRefNum in the resulting object will be “0”.\nIf successful this method will return a Receipt object. If receipt is not found and exception will be thrown.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[Receipt](/docs/receipt) **getReceiptByName** ( [ueSecurityToken](/docs/uesecuritytoken), Name)\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\": \"string\",\n    \"1-1\": \"Name\",\n    \"1-2\": \"Name of receipt\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\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\": \"[Receipt](/docs/receipt)\",\n    \"0-1\": \"Returns a Receipt object for the requested 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\": \"20030\",\n    \"0-1\": \"Requested receipt not found\",\n    \"0-2\": \"No receipts were matched using Name.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\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 $Name = 'vterm';\\n $res = $client->getReceiptByName($token, $Name);\\n echo base64_decode($res->TemplateText);\\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 receipt As eBizCharge.Receipt\\n       Dim receiptName As String\\n       receiptName = \\\"recurring\\\"\\n       receipt = client.getReceiptByName(token, receiptName)\\n       MsgBox(receipt.ReceiptRefNum)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string name = \\\"test receipt\\\";\\n           try\\n           {\\n               eBizCharge.Receipt receipt = client.getReceiptByName(token, name);\\n               MessageBox.Show(string.Concat(receipt.ReceiptRefNum));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML (RPC/Encoded) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Request:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\" xmlns:ns1=\\\"urn:eBizCharge\\\"\\n       xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n       xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n       xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n       SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:getReceiptByName>\\n       <Token xsi:type=\\\"ns1:ueSecurityToken\\\">\\n               <ClientIP xsi:type=\\\"xsd:string\\\">192.168.0.1</ClientIP>\\n               <PinHash xsi:type=\\\"ns1:ueHash\\\">\\n                       <HashValue xsi:type=\\\"xsd:string\\\">8f63a3359735a07580f240b9eb31f776492e7793</HashValue>\\n                       <Seed xsi:type=\\\"xsd:string\\\">12517578291984318268</Seed>\\n                       <Type xsi:type=\\\"xsd:string\\\">sha1</Type>\\n               </PinHash>\\n               <SourceKey xsi:type=\\\"xsd:string\\\">1B93L5cpXV5hbx557d183q96EZ2jpqEf</SourceKey>\\n       </Token>\\n       <Name xsi:type=\\\"xsd:string\\\">vterm</Name>\\n</ns1:getReceiptByName>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n       xmlns:ns1=\\\"urn:eBizCharge\\\"\\n       xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n       xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n       xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n       SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:getReceiptByNameResponse>\\n<getReceiptByNameReturn xsi:type=\\\"ns1:Receipt\\\">\\n       <ReceiptRefNum xsi:type=\\\"xsd:integer\\\">25</ReceiptRefNum>\\n       <Name xsi:type=\\\"xsd:string\\\">test1</Name>\\n       <Subject xsi:type=\\\"xsd:string\\\">test2</Subject>\\n       <FromEmail xsi:type=\\\"xsd:string\\\">test:::at:::testing3.com</FromEmail>\\n       <Target xsi:type=\\\"xsd:string\\\">email</Target>\\n       <ContentType xsi:type=\\\"xsd:string\\\">both</ContentType>\\n       <TemplateHTML xsi:type=\\\"xsd:string\\\">dGVzdDM=</TemplateHTML>\\n       <TemplateText xsi:type=\\\"xsd:string\\\">dGVzdDQ=</TemplateText>\\n       </getReceiptReturn>\\n</ns1:getReceiptByNameResponse>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getreceiptbyname","type":"basic","title":"getReceiptByName"}
Retrieve a receipt template identified by Name. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method allows you to retrieve the receipt template identified by Name. This method will return the merchant's receipt template if it exists. Otherwise, if a system default template exists for “Name” it will be returned. If a system default is returned, the ReceiptRefNum in the resulting object will be “0”. If successful this method will return a Receipt object. If receipt is not found and exception will be thrown. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [Receipt](/docs/receipt) **getReceiptByName** ( [ueSecurityToken](/docs/uesecuritytoken), Name) [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": "string", "1-1": "Name", "1-2": "Name of receipt" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "[Receipt](/docs/receipt)", "0-1": "Returns a Receipt object for the requested 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": "20030", "0-1": "Requested receipt not found", "0-2": "No receipts were matched using Name." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $Name = 'vterm';\n $res = $client->getReceiptByName($token, $Name);\n echo base64_decode($res->TemplateText);\n}\ncatch(SoapFault $e) {\n echo $e->getMessage();\n}\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim receipt As eBizCharge.Receipt\n Dim receiptName As String\n receiptName = \"recurring\"\n receipt = client.getReceiptByName(token, receiptName)\n MsgBox(receipt.ReceiptRefNum)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string name = \"test receipt\";\n try\n {\n eBizCharge.Receipt receipt = client.getReceiptByName(token, name);\n MessageBox.Show(string.Concat(receipt.ReceiptRefNum));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block] ## XML (RPC/Encoded) [block:code] { "codes": [ { "code": "Request:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns1=\"urn:eBizCharge\"\n xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:getReceiptByName>\n <Token xsi:type=\"ns1:ueSecurityToken\">\n <ClientIP xsi:type=\"xsd:string\">192.168.0.1</ClientIP>\n <PinHash xsi:type=\"ns1:ueHash\">\n <HashValue xsi:type=\"xsd:string\">8f63a3359735a07580f240b9eb31f776492e7793</HashValue>\n <Seed xsi:type=\"xsd:string\">12517578291984318268</Seed>\n <Type xsi:type=\"xsd:string\">sha1</Type>\n </PinHash>\n <SourceKey xsi:type=\"xsd:string\">1B93L5cpXV5hbx557d183q96EZ2jpqEf</SourceKey>\n </Token>\n <Name xsi:type=\"xsd:string\">vterm</Name>\n</ns1:getReceiptByName>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\"\n xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:getReceiptByNameResponse>\n<getReceiptByNameReturn xsi:type=\"ns1:Receipt\">\n <ReceiptRefNum xsi:type=\"xsd:integer\">25</ReceiptRefNum>\n <Name xsi:type=\"xsd:string\">test1</Name>\n <Subject xsi:type=\"xsd:string\">test2</Subject>\n <FromEmail xsi:type=\"xsd:string\">test@testing3.com</FromEmail>\n <Target xsi:type=\"xsd:string\">email</Target>\n <ContentType xsi:type=\"xsd:string\">both</ContentType>\n <TemplateHTML xsi:type=\"xsd:string\">dGVzdDM=</TemplateHTML>\n <TemplateText xsi:type=\"xsd:string\">dGVzdDQ=</TemplateText>\n </getReceiptReturn>\n</ns1:getReceiptByNameResponse>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]