{"_id":"5632a5eb49e16d0d001224b4","project":"55b933b3146ef121002158d3","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,"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"},"user":"55b932ba8fd1a02b00f496c8","githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:00:33.310Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Emails a new receipt for an existing transaction. Selects receipt by name.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis 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](/docs/transactionresponse) or retrieved with [searchTransactionsCustom](/docs/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:\n\n  * vterm -Virtual Terminal (Printed)\n  * vterm_merchant -Virtual Terminal (Merchant Email)\n  * vterm_customer -Virtual Terminal (Customer Email)\n  * saleform_merchant -Sale Form (Merchant Email)\n  * saleform_customer -Sale Form (Customer Email)\n  * tranapi -Transaction API and Payment Form (Merchant)\n  * tranapi_customer -Transaction API and Payment Form (Customer) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nboolean **emailTransactionReceiptByName** ( [ueSecurityToken](/docs/uesecuritytoken), TransactionRefNum, ReceiptName, EmailAddress)\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\": \"TrasnactionRefNum\",\n    \"1-2\": \"Transaction reference number assigned by the gateway to every transaction.\",\n    \"2-0\": \"String\",\n    \"2-1\": \"ReceiptName\",\n    \"2-2\": \"Name of the receipt template you want to send, assigned by user when the template is created.\",\n    \"3-0\": \"String\",\n    \"3-1\": \"EmailAddress\",\n    \"3-2\": \"The email address you want to send the receipt to.\"\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\": \"boolean\",\n    \"0-1\": \"Indicates if the receipt sent successfully\"\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\": \"TransactionRefNum did not match a Transaction in the merchants account.\",\n    \"1-0\": \"20030\",\n    \"1-1\": \"Requested receipt not found\",\n    \"1-2\": \"Receipt did not match any of the merchants receipts\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\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 $TransactionRefNum=123456789;        \\n $sent = $this->client->emailTransactionReceiptByName($this->token, $RefNum, 'tranapi', 'email:::at:::address.com');;\\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 refnum As String\\n       refnum = \\\"46973419\\\"\\n       Dim result As Boolean\\n       result = client.emailTransactionReceiptByName(token, refnum, \\\"recurring\\\", \\\"email@mycompany.com\\\")\\n       MsgBox(result)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string refnum;\\n           refnum = \\\"46973419\\\";\\n           Boolean result;\\n           try\\n           {\\n               result = client.emailTransactionReceiptByName(token, refnum, \\\"recurring\\\", \\\"email@yourdomain.com\\\");\\n               if (result)\\n               {\\n                   MessageBox.Show(string.Concat(\\\"Email is sent\\\"));\\n               }\\n               else MessageBox.Show(\\\"Error\\\");\\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\\nxmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\nxmlns:ns1=\\\"urn:eBizCharge\\\"\\nxmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\nxmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\nxmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\nSOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:emailTransactionReceiptByName>\\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\\\">491cf3d49644e80b7d854268fe0b1b39cbfa1e92</HashValue>\\n  <Seed xsi:type=\\\"xsd:string\\\">1267817706259452304</Seed>\\n  <Type xsi:type=\\\"xsd:string\\\">sha1</Type>\\n </PinHash>\\n <SourceKey xsi:type=\\\"xsd:string\\\">1B93L5cpXV5hbx557d183q96EZ2jpqEf</SourceKey>\\n</Token>\\n<RefNum xsi:type=\\\"xsd:integer\\\">1335780</RefNum>\\n<ReceiptName xsi:type=\\\"xsd:string\\\">tranapi</ReceiptName>\\n<Email xsi:type=\\\"xsd:string\\\">email@address.com</Email>\\n</ns1:emailTransactionReceiptByName>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope\\nxmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\nxmlns:ns1=\\\"urn:eBizCharge\\\"\\nxmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\nxmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\nxmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\nSOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:emailTransactionReceiptByNameResponse>\\n<emailTransactionReceiptByNameReturn xsi:type=\\\"xsd:boolean\\\">true</emailTransactionReceiptByNameReturn>\\n</ns1:emailTransactionReceiptByNameResponse>\\n</SOAP-ENV:Body></SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"emailtransactionreceiptbyname","type":"basic","title":"emailTransactionReceiptByName"}

emailTransactionReceiptByName


Emails a new receipt for an existing transaction. Selects receipt by name. [block:api-header] { "type": "basic", "title": "Description" } [/block] 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](/docs/transactionresponse) or retrieved with [searchTransactionsCustom](/docs/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) [block:api-header] { "type": "basic", "title": "Syntax" } [/block] boolean **emailTransactionReceiptByName** ( [ueSecurityToken](/docs/uesecuritytoken), TransactionRefNum, ReceiptName, EmailAddress) [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": "TrasnactionRefNum", "1-2": "Transaction reference number assigned by the gateway to every transaction.", "2-0": "String", "2-1": "ReceiptName", "2-2": "Name of the receipt template you want to send, assigned by user when the template is created.", "3-0": "String", "3-1": "EmailAddress", "3-2": "The email address you want to send the receipt to." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "boolean", "0-1": "Indicates if the receipt sent successfully" }, "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": "TransactionRefNum did not match a Transaction in the merchants account.", "1-0": "20030", "1-1": "Requested receipt not found", "1-2": "Receipt did not match any of the merchants receipts" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $TransactionRefNum=123456789; \n $sent = $this->client->emailTransactionReceiptByName($this->token, $RefNum, 'tranapi', 'email@address.com');;\n}\ncatch(SoapFault $e) {\n echo $e->getMessage();\n}\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim refnum As String\n refnum = \"46973419\"\n Dim result As Boolean\n result = client.emailTransactionReceiptByName(token, refnum, \"recurring\", \"email@mycompany.com\")\n MsgBox(result)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string refnum;\n refnum = \"46973419\";\n Boolean result;\n try\n {\n result = client.emailTransactionReceiptByName(token, refnum, \"recurring\", \"email@yourdomain.com\");\n if (result)\n {\n MessageBox.Show(string.Concat(\"Email is sent\"));\n }\n else MessageBox.Show(\"Error\");\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\nxmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\nxmlns:ns1=\"urn:eBizCharge\"\nxmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\nxmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\nxmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\nSOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:emailTransactionReceiptByName>\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\">491cf3d49644e80b7d854268fe0b1b39cbfa1e92</HashValue>\n <Seed xsi:type=\"xsd:string\">1267817706259452304</Seed>\n <Type xsi:type=\"xsd:string\">sha1</Type>\n </PinHash>\n <SourceKey xsi:type=\"xsd:string\">1B93L5cpXV5hbx557d183q96EZ2jpqEf</SourceKey>\n</Token>\n<RefNum xsi:type=\"xsd:integer\">1335780</RefNum>\n<ReceiptName xsi:type=\"xsd:string\">tranapi</ReceiptName>\n<Email xsi:type=\"xsd:string\">email@address.com</Email>\n</ns1:emailTransactionReceiptByName>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope\nxmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\nxmlns:ns1=\"urn:eBizCharge\"\nxmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\nxmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\nxmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\nSOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:emailTransactionReceiptByNameResponse>\n<emailTransactionReceiptByNameReturn xsi:type=\"xsd:boolean\">true</emailTransactionReceiptByNameReturn>\n</ns1:emailTransactionReceiptByNameResponse>\n</SOAP-ENV:Body></SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]