{"_id":"5632a5eb49e16d0d001224b7","__v":0,"githubsync":"","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"},"user":"55b932ba8fd1a02b00f496c8","project":"55b933b3146ef121002158d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:01:36.252Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"Creates a new receipt template\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to create a new custom receipt template. Once a template has been created it can be selected when running a transaction via one of the transaction methods such as [runSale](/docs/run-sale) or a receipt can be rendered manually for a transaction using [renderReceipt](/docs/renderreceipt).\nFor more information about the template syntax and available fields, see the [template documentation](#)\nFor security reasons, the default templates can not be modified via this method.\nIf the receipt is created successfully a ReceiptRefNum will be returned. This ID is used to uniquely identify the receipt. If an error occurs, an exception will be thrown.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\ninteger **addReceipt** ( [ueSecurityToken](/docs/uesecuritytoken), [Receipt ](/docs/receipt))\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\": \"[Receipt](/docs/receipt)\",\n    \"1-1\": \"Receipt\",\n    \"1-2\": \"Receipt object containing receipt template data\"\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\": \"integer\",\n    \"0-1\": \"Returns the gateway assigned ReceiptRefNum\"\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\": \"20031\",\n    \"0-1\": \"Invalid content type\",\n    \"0-2\": \"ContentType must be either Text, HTML or Both\",\n    \"1-0\": \"20032\",\n    \"1-1\": \"Invalid receipt target\",\n    \"1-2\": \"Receipt Target must be either Email or Print\",\n    \"2-0\": \"20033\",\n    \"2-1\": \"Receipt name already used\",\n    \"2-2\": \"Receipt template names must be unique\"\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 $Receipt = array(\\n   \\\"Name\\\" => \\\"CartReceipt1\\\",\\n   \\\"Subject\\\" => \\\"Sample Cart Order # [Transaction.OrderID]\\\",\\n   \\\"TemplateHTML\\\"=>base64_encode('Yippe skippy  [Transaction.Created]'),\\n   \\\"TemplateText\\\"=>base64_encode('Yippe skippy  [Transaction.Created]'),\\n   \\\"ContentType\\\" => 'both',\\n   \\\"Target\\\" => 'email',\\n   \\\"FromEmail\\\" => 'noreply:::at:::mysamplecart.com'\\n );                \\n $refnum = $client->addReceipt($token, $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 receipt As eBizCharge.Receipt = New eBizCharge.Receipt\\n       receipt.Name = \\\"test receipt_VB\\\"\\n       receipt.Target = \\\"email\\\"\\n       receipt.Subject = \\\"test receipt\\\"\\n       receipt.FromEmail = \\\"devsupport@eBizCharge.com\\\"\\n       receipt.ContentType = \\\"text\\\"\\n       Dim message As String\\n       message = \\\"Yippy skippy\\\"\\n       Dim toencode As Byte() = System.Text.ASCIIEncoding.ASCII.GetBytes(message)\\n       Dim returnValue As String\\n       returnValue = System.Convert.ToBase64String(toencode)\\n       receipt.TemplateText = returnValue\\n       Dim receiptNum As String\\n       receiptNum = client.addReceipt(token, receipt)\\n       MsgBox(receiptNum)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.Receipt receipt = new eBizCharge.Receipt();\\n           receipt.Name = \\\"test receipt\\\";\\n           receipt.Target = \\\"email\\\";\\n           receipt.Subject = \\\"test receipt\\\";\\n           receipt.FromEmail = \\\"devsupport@eBizCharge.com\\\";\\n           receipt.ContentType = \\\"text\\\";\\n           string message = \\\"Yippy Skippy\\\";\\n           byte[] toencodeAsBytes = System.Text.ASCIIEncoding.ASCII.GetBytes(message);\\n           string returnValue = System.Convert.ToBase64String(toencodeAsBytes);\\n           receipt.TemplateText = returnValue;\\n           string receiptRefNum;\\n           try\\n           {\\n               receiptRefNum = client.addReceipt(token, receipt);\\n               MessageBox.Show(string.Concat(receiptRefNum));\\n           }\\n          catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Request:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope\\n xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n xmlns:ns1=\\\"urn:eBizCharge\\\" 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:addReceipt>\\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\\\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\\n<Seed xsi:type=\\\"xsd:string\\\">12678150211876663375</Seed>\\n<Type xsi:type=\\\"xsd:string\\\">sha1</Type>\\n</PinHash>\\n<SourceKey xsi:type=\\\"xsd:string\\\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\\n</Token>\\n <Receipt xsi:type=\\\"ns1:Receipt\\\">\\n   <Name xsi:type=\\\"xsd:string\\\">addReceipt1909111717</Name>\\n   <Subject xsi:type=\\\"xsd:string\\\">1561375697</Subject>\\n   <FromEmail xsi:type=\\\"xsd:string\\\">test@test22.com</FromEmail>\\n   <Target xsi:type=\\\"xsd:string\\\">email</Target>\\n   <ContentType xsi:type=\\\"xsd:string\\\">both</ContentType>  \\n   <TemplateHTML xsi:type=\\\"xsd:string\\\">WWlwcGUgc2tpcHB5ICBbVHJhbnNhY3Rpb24uQ3JlYXRlZF0=</TemplateHTML>\\n   <TemplateText xsi:type=\\\"xsd:string\\\">WWlwcGUgc2tpcHB5ICBbVHJhbnNhY3Rpb24uQ3JlYXRlZF0=</TemplateText>\\n </Receipt>\\n</ns1:addReceipt>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope\\n xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n xmlns:ns1=\\\"urn:eBizCharge\\\"\\n xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:addReceiptResponse>\\n <addReceiptResponseReturn xsi:type=\\\"xsd:integer\\\">32</addReceiptResponseReturn>\\n</ns1:addReceiptResponse>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"addreceipt","type":"basic","title":"addReceipt"}
Creates a new receipt template [block:api-header] { "type": "basic", "title": "Description" } [/block] This method allows you to create a new custom receipt template. Once a template has been created it can be selected when running a transaction via one of the transaction methods such as [runSale](/docs/run-sale) or a receipt can be rendered manually for a transaction using [renderReceipt](/docs/renderreceipt). For more information about the template syntax and available fields, see the [template documentation](#) For security reasons, the default templates can not be modified via this method. If the receipt is created successfully a ReceiptRefNum will be returned. This ID is used to uniquely identify the receipt. If an error occurs, an exception will be thrown. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] integer **addReceipt** ( [ueSecurityToken](/docs/uesecuritytoken), [Receipt ](/docs/receipt)) [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": "[Receipt](/docs/receipt)", "1-1": "Receipt", "1-2": "Receipt object containing receipt template data" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "integer", "0-1": "Returns the gateway assigned ReceiptRefNum" }, "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": "20031", "0-1": "Invalid content type", "0-2": "ContentType must be either Text, HTML or Both", "1-0": "20032", "1-1": "Invalid receipt target", "1-2": "Receipt Target must be either Email or Print", "2-0": "20033", "2-1": "Receipt name already used", "2-2": "Receipt template names must be unique" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $Receipt = array(\n \"Name\" => \"CartReceipt1\",\n \"Subject\" => \"Sample Cart Order # [Transaction.OrderID]\",\n \"TemplateHTML\"=>base64_encode('Yippe skippy [Transaction.Created]'),\n \"TemplateText\"=>base64_encode('Yippe skippy [Transaction.Created]'),\n \"ContentType\" => 'both',\n \"Target\" => 'email',\n \"FromEmail\" => 'noreply@mysamplecart.com'\n ); \n $refnum = $client->addReceipt($token, $Receipt);\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 = New eBizCharge.Receipt\n receipt.Name = \"test receipt_VB\"\n receipt.Target = \"email\"\n receipt.Subject = \"test receipt\"\n receipt.FromEmail = \"devsupport@eBizCharge.com\"\n receipt.ContentType = \"text\"\n Dim message As String\n message = \"Yippy skippy\"\n Dim toencode As Byte() = System.Text.ASCIIEncoding.ASCII.GetBytes(message)\n Dim returnValue As String\n returnValue = System.Convert.ToBase64String(toencode)\n receipt.TemplateText = returnValue\n Dim receiptNum As String\n receiptNum = client.addReceipt(token, receipt)\n MsgBox(receiptNum)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.Receipt receipt = new eBizCharge.Receipt();\n receipt.Name = \"test receipt\";\n receipt.Target = \"email\";\n receipt.Subject = \"test receipt\";\n receipt.FromEmail = \"devsupport@eBizCharge.com\";\n receipt.ContentType = \"text\";\n string message = \"Yippy Skippy\";\n byte[] toencodeAsBytes = System.Text.ASCIIEncoding.ASCII.GetBytes(message);\n string returnValue = System.Convert.ToBase64String(toencodeAsBytes);\n receipt.TemplateText = returnValue;\n string receiptRefNum;\n try\n {\n receiptRefNum = client.addReceipt(token, receipt);\n MessageBox.Show(string.Concat(receiptRefNum));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "Request:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope\n xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\" 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:addReceipt>\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\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\n<Seed xsi:type=\"xsd:string\">12678150211876663375</Seed>\n<Type xsi:type=\"xsd:string\">sha1</Type>\n</PinHash>\n<SourceKey xsi:type=\"xsd:string\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\n</Token>\n <Receipt xsi:type=\"ns1:Receipt\">\n <Name xsi:type=\"xsd:string\">addReceipt1909111717</Name>\n <Subject xsi:type=\"xsd:string\">1561375697</Subject>\n <FromEmail xsi:type=\"xsd:string\">test@test22.com</FromEmail>\n <Target xsi:type=\"xsd:string\">email</Target>\n <ContentType xsi:type=\"xsd:string\">both</ContentType> \n <TemplateHTML xsi:type=\"xsd:string\">WWlwcGUgc2tpcHB5ICBbVHJhbnNhY3Rpb24uQ3JlYXRlZF0=</TemplateHTML>\n <TemplateText xsi:type=\"xsd:string\">WWlwcGUgc2tpcHB5ICBbVHJhbnNhY3Rpb24uQ3JlYXRlZF0=</TemplateText>\n </Receipt>\n</ns1:addReceipt>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope\n xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:addReceiptResponse>\n <addReceiptResponseReturn xsi:type=\"xsd:integer\">32</addReceiptResponseReturn>\n</ns1:addReceiptResponse>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]