Used to terminate the current session. Security tokens have an expiration date of 15 minutes from when issued by login and a logout is not required.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","logout"],"host":["https://devtest.receiptx.com/VRG"],"query":[],"variable":[]}},"response":[{"id":"f4ccbe1b-024b-4f75-8650-a03a01990f18","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://devtest.receiptx.com/VRG/file/logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"e892f9c0-ef3e-4c48-b9be-7bc9c7896f33","name":"800:Logout Success","originalRequest":{"method":"GET","header":[],"url":"https://devtest.receiptx.com/VRG/file/logout"},"status":"800:Logout Success","_postman_previewlanguage":"html","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Content-Type","value":"text/html"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 08 Mar 2021 16:02:55 GMT"}],"cookie":[],"responseTime":null,"body":"This service authenticates end users accessing the Virtual Receipt Gateway(VRG).
\n","_postman_id":"b7426fec-4da3-4492-9248-83aa274ef400","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}}},{"name":"eReceipt","item":[{"name":"Login and Upload files","id":"62417dbd-afeb-4c0b-91de-ed079d001989","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"type","value":"Always file
\n"},{"key":"name","value":"Result file name
\n"},{"key":"encoded-file-data","type":"file","description":"Contents of file
\n","value":null}]},"url":"https://devtest.receiptx.com/VRG/file/loginupload?username=&password=","description":"Uploading XML/JSON files with username and password
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","loginupload"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Customer Username
\n","type":"text/plain"},"key":"username","value":""},{"description":{"content":"(Required) Customer Password
\n","type":"text/plain"},"key":"password","value":""}],"variable":[]}},"response":[{"id":"76390f46-14b0-4779-824a-4451bd73dc2b","name":"701","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"type","value":"Always file
\n"},{"key":"name","value":"Result file name
\n"},{"key":"encoded-file-data","type":"file","description":"Contents of file
\n","value":null}]},"url":"https://devtest.receiptx.com/VRG/file/upload?sectoken=Uploading XML/JSON files with the security token.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","upload"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Security Token used for authentication to system. Acquired during login process.
\n","type":"text/plain"},"key":"sectoken","value":"This service is used to send digital receipt data to the VRG.
\nTransactionTree Digital Receipt Schema: https://www.transactiontree.com/framework/schema/vrg/3.2.2/
This uses the user name and password in the lookup call.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","logingetemail"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Customer Username
\n","type":"text/plain"},"key":"username","value":"(Required) Customer Password
\n","type":"text/plain"},"key":"password","value":"The type of ID that is being used for the lookup
\n","type":"text/plain"},"key":"lookuptype","value":"The value of the lookuptype being used
\n","type":"text/plain"},"key":"lookupid","value":"This uses the user name and password in the lookup call.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","logingetemail"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Customer Username
\n","type":"text/plain"},"key":"username","value":"(Required) Customer Password
\n","type":"text/plain"},"key":"password","value":"Lookuptype2 and lookupid2 are used first and if not found then moves on to lookupid1.
\n","type":"text/plain"},"key":"lookuptype2","value":"The type of ID that is being used for the lookup
\n","type":"text/plain"},"key":"lookuptype1","value":"The value of the lookuptype1 being used
\n","type":"text/plain"},"key":"lookupid1","value":"The value of the lookuptype2 being used
\n","type":"text/plain"},"key":"lookupid2","value":"It is used to look up email address by transid, altid, or loyaltyid.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","logingetemail"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Security Token used for authentication to system. Acquired during login process.
\n","type":"text/plain"},"key":"sectoken","value":"The type of ID that is being used for the lookup.
\n","type":"text/plain"},"key":"lookuptype","value":"The value of the lookuptype being used
\n","type":"text/plain"},"key":"lookupid","value":"Login and Put Email
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","loginputemail"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Security Token used for authentication to system. Acquired during login process.
\n","type":"text/plain"},"key":"sectoken","value":"(Required) The type of ID that is being used for the lookup
\n","type":"text/plain"},"key":"lookuptype","value":"(Required) The value of the lookuptype being used
\n","type":"text/plain"},"key":"lookupid","value":"(Required) Email Address
\n","type":"text/plain"},"key":"email","value":"(Required) Email Receipt Preference
\n","type":"text/plain"},"key":"er_preference","value":"Login and Put Email
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","loginputemail"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Customer Username
\n","type":"text/plain"},"key":"username","value":"(Required) Customer Password
\n","type":"text/plain"},"key":"password","value":"(Required) The type of ID that is being used for the lookup
\n","type":"text/plain"},"key":"lookuptype","value":"(Required) The value of the lookuptype being used
\n","type":"text/plain"},"key":"lookupid","value":"(Required) Email Address
\n","type":"text/plain"},"key":"email","value":"(Required) Email Receipt Preference
\n","type":"text/plain"},"key":"er_preference","value":"\"altid\" used for phone number or \"loyaltyid\" used for customer ID
\n","type":"text/plain"},"key":"lookuptype","value":"0 for false or 1 for true
\n","type":"text/plain"},"key":"email_marketing_flag","value":"0 for false or 1 for true
\n","type":"text/plain"},"key":"sms_marketing_flag","value":"email, print, both, or noprint
\n","type":"text/plain"},"key":"receipt_preference","value":"altid used for phone number or loyaltyid used for customer ID
\n","type":"text/plain"},"key":"lookuptype","value":"Customer lookup is used to get an email address and receipt preferences using transid, altid, or loyaltyid. In addition, a customer can also be updated or created with this service.\n
| Example Responses | \nRecommended Screen | \n
|---|---|
\n <response>800\n <email>pparker@transactiontree.com</email>\n </response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-800.jpg\") | \n
\n <response>801\n <email>pparker@transactiontree.com</email>\n <er_preference>email</er_preference>\n </response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-801.jpg\") | \n
\n <response>802:NoEmail</response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-802.jpg\") | \n
\n <response>803\n <email>pparker@transactiontree.com</email>\n </response>\n | \n | \n
\n <response>804:Bounced</response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-804a.jpg\") \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-804b.jpg\") | \n
\n <response>805:Blacklisted</response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-805.jpg\") | \n
\n <response>806:Format</response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-806.jpg\") | \n
\n <response>807\n <email>pparker@transactiontree.com</email>\n </response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-807.jpg\") | \n
\n <response>808\n <email>pparker@transactiontree.com</email>\n </response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-808.jpg\") | \n
\n <response>809:Forbidden</response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-809.jpg\") | \n
\n <response>810\n <email>pparker@transactiontree.com</email>\n <email>pp@transactiontree.com</email>\n <email>p1@transactiontree.com</email>\n </response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-810.jpg\") | \n
This uses the user name and password in the lookup call.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","logincheckemail"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Customer Username
\n","type":"text/plain"},"key":"username","value":"(Required) Customer Password
\n","type":"text/plain"},"key":"password","value":"Should always be email in this call
\n","type":"text/plain"},"key":"lookuptype","value":"email"},{"description":{"content":"The email address that is being validated
\n","type":"text/plain"},"key":"lookupid","value":"This uses the security token in the call.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["file","logincheckemail"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"description":{"content":"(Required) Security Token used for authentication to system. Acquired during login process.
\n","type":"text/plain"},"key":"sectoken","value":"Should always be email in this call
\n","type":"text/plain"},"key":"lookuptype","value":"email"},{"description":{"content":"The email address that is being validated
\n","type":"text/plain"},"key":"lookupid","value":"Check email is used to validate an email address against TransactionTree's proprietary system, The email is checked for format, domain validation, domain rule validation, and universal block list. \n
| Example Responses | \nRecommended Screen | \n
|---|---|
\n <response>806:Email Format</response>\n | \n | \n
\n <response>815:Domain Blocked</response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-815.jpg\") | \n
\n <response>811:No MX Record</response>\n | \n | \n
\n <response>812: Domain Corrected\n <email>test@gmail.com</email>\n </response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-812.jpg\") | \n
\n <response>813:Check Local Part</response>\n | \n ![](\"https://www.transactiontree.com/framework/schema/vrg/screens/eft-813.jpg\") | \n
\n <response>805:Email Blocklist</response>\n | \n | \n
\n <response>814:Valid Format</response>\n | \n | \n
Always file
\n","type":"text"},{"key":"name","value":"Result file name
\n","type":"text"},{"key":"encoded-file-data","description":"Contents of file
\n","type":"file","value":null}]},"url":"https://devtest.receiptx.com/VRG/Batch/ProductUpdate?sectoken=All files should be in .zip format prior to sending.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}},"urlObject":{"path":["Batch","ProductUpdate"],"host":["https://devtest.receiptx.com/VRG"],"query":[{"key":"sectoken","value":"This service is used to update product information in the system.
\nSchema: UpdateProductInformationRequestXML.xsd
\n","_postman_id":"431a4f1a-50bc-489d-9610-93596849c4f7","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98d04d00-fcc0-4b08-abdd-1052918b499d","id":"98d04d00-fcc0-4b08-abdd-1052918b499d","name":"Virtual Receipt Gateway","type":"folder"}}},{"name":"Test Cases","item":[],"id":"3df0038b-76be-485f-be3e-b5532b72f5e2","description":"Below are test cases that can be used to get the different response from the endpoints logingetemail and logincheckemail.
\n| EndPoint | Status Code | Status Detail | lookuptype | lookupid |
|---|---|---|---|---|
| logingetemail | 800 | Email Address no preference | altid | 17708630881 |
| logingetemail | 801 | Email Address with preference (email) | altid | 17708630878 |
| logingetemail | 801 | Email Address with preference (print) | altid | 17708630879 |
| logingetemail | 801 | Email Address with preference (both) | altid | 17708630880 |
| logingetemail | 802 | NoEmail | altid | 17708630001 |
| logingetemail | 803 | Valid Email but no Receipt preference | altid | 17708630000 |
| logingetemail | 804 | Bounced | altid | 17708630002 |
| logincheckemail | 805 | Email Blocklist | ispsupport@gmail.com | |
| logingetemail | 805 | Email Blocklist | altid | 17708630003 |
| logingetemail | 806 | Format | altid | 17708630004 |
| logincheckemail | 806 | Format | checkformat.@gmail.com | |
| logingetemail | 807 | Spamtrap | altid | 17708638811 |
| logincheckemail | 807 | Spamtrap | spamtrap@gmail.com | |
| logingetemail | 808 | Abuse | altid | 17708630005 |
| logingetemail | 809 | Forbidden | altid | 17708630007 |
| logingetemail | 810 | Multiple Emails | altid | 17708630008 |
| logincheckemail | 811 | No MX Record | jasonretail1@gamebox.net | |
| logincheckemail | 812 | Domain Corrected | jasonretail1@gamil.com | |
| logincheckemail | 814 | Valid Email Format | jasonretail1@gmail.com | |
| logincheckemail | 815 | Domain Blocked | jasonretail1@donotuse.com | |
| loginputemail | 817 | Phone Prefix Blocked | altid | 17705551234 |
| loginputemail | 818 | Phone Area Code Blocked | altid | 15558630878 |
| Type | \nCode | \nReason | \nDescription | \n
|---|---|---|---|
| Error | \n400 | \nBad Request | \nBad syntax in the client request | \n
| Error | \n401 | \nUnauthorized | \nThis is used when the resource is restricted to certain authenticated users. | \n
| Error | \n403 | \nForbidden | \nUser made a valid request but the server is refusing to serve the request, due to a lack of permission to access the requested resource | \n
| Error | \n404 | \nNot Found | \nUser is able to communicate with the server but it is unable to locate the requested file or resource | \n
| Error | \n405 | \nMethod Not Allowed | \nThis is used when the request is well-formed and the resource it asks for does exist, but the request method (such as GET or POST) is not appropriate to the resource. | \n
| Error | \n410 | \nGone | \nStatus code is used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address | \n
| Error | \n500 | \nInternal Server Error | \nThe server cannot process the request for an unknown reason | \n
| Error | \n501 | \nNot Implemented | \nThis is returned when the HTTP request method (such as PUT or DELETE), the API method in some cases, has not yet been implemented. | \n
| Error | \n502 | \nBad Gateway | \nMeans that the server is not receiving a valid response from the backend servers that should actually fulfill the request | \n
| Error | \n503 | \nService Unavailable | \nMeans that the server is overloaded or under maintenance | \n
| Error | \n504 | \nTimeout | \nMeans that the server is not receiving a response from the backend servers within the allowed time period. | \n
| Error | \n505 | \nHTTP Version Not Supported | \nThe HTTP protocol version used in the request. | \n
| Error | \n701 | \nInvalid username or password | \nThe username or password provide is invalid. | \n
| Error | \n702 | \nInvalid Security Token | \nThe security token provided is not valid. | \n
| Error | \n703 | \nSecurity Token Expired | \nThe security token provided has expired. | \n
| Error | \n705 | \nGeneral Error | \nThis is a general error. | \n
| Error | \n708 | \nMissing File | \nFile was not attached in the message. | \n
| Valid | \n800 | \nUpload Success | \nThe upload has been excepted by the VRG. | \n
| Valid | \n800 | \nLogout Success | \nLogout was success. | \n
| Valid | \n800 | \nEmail Address | \nThe email address that the VRG has on file. | \n
| Valid | \n801 | \nEmail address with preference | \nThe email on file has a receipt preference saved. | \n
| Valid | \n802 | \nNoEmail | \nNo email is on file for the id provided. | \n
| Valid | \n803 | \nEmail but no Receipt preference | \nAn email is on file for the id provided but no receipt preference has been saved | \n
| Valid | \n804 | \nBounced | \nThe email on file for this id has bounced prior | \n
| Valid | \n805 | \nEmail Blocklist | \nThe email on file has been added to the blocklist and is no allowed. Ask user to contact a service rep. | \n
| Valid | \n806 | \nFormat | \nEmails that fail RFC syntax protocols | \n
| Valid | \n807 | \nSpamtrap | \nThese emails are believed to be spamtraps and should not be mailed. We have technology in place to determine if certain emails should be classified as spamtrap. We don't know all the spamtrap email addresses, but we do know a lot of them. | \n
| Valid | \n808 | \nAbuse | \nThese emails are of people who are known to click the abuse or spam links in emails, hence abusers or complainers. We recommend not emailing these addresses. If you wish to email display a message targeted at these email addresses. | \n
| Valid | \n809 | \nForbidden | \nAn id has been provided that is not allowed to be emailed to. | \n
| Valid | \n810 | \nMultiple Emails | \nMultiple Email addresses found for ID | \n
| Valid | \n811 | \nNo MX Record | \nThe domain that an email is going to can not receive emails. | \n
| Valid | \n812 | \nDomain Corrected | \nThe email domain has been automatically corrected. Please have customer check email address again. | \n
| Valid | \n814 | \nValid Email Format | \nThe email address has passed all format and block list checks. | \n
| Valid | \n815 | \nDomain Blocked | \nThis domain is blocked by TransactionTree and no emails will be sent. | \n
| Valid | \n817 | \nPhone Prefix Blocked | \nThe prefix of the phone number is not allowed. | \n
| Valid | \n818 | \nPhone Area Code Blocked | \nThe area code of the phone number is not allowed. | \n
Print string text.
\n","type":"text"},{"key":"SignatureFile0","value":"","description":"Image of signature in svg or jpeg format. Images will be placed in order received.
\n","type":"text"},{"key":"SignatureFile1","value":"","description":"Image of signature in svg or jpeg format. Images will be placed in order received.
\n","type":"text"},{"key":"SignatureFile2","value":"","description":"Image of signature in svg or jpeg format. Images will be placed in order received.
\n","type":"text"},{"key":"SignatureFile3","value":"","description":"Image of signature in svg or jpeg format. Images will be placed in order received.
\n","type":"text"},{"key":"SignatureFile4","value":"","description":"Image of signature in svg or jpeg format. Images will be placed in order received.
\n","type":"text"},{"key":"SignatureFile5","value":"","description":"Image of signature in svg or jpeg format. Images will be placed in order received.
\n","type":"text"},{"key":"SignatureFile6","value":"","description":"Image of signature in svg or jpeg format. Images will be placed in order received.
\n","type":"text"},{"key":"SignatureFile7","value":"","description":"Image of signature in svg or jpeg format. Images will be placed in order received.
\n","type":"text"}]},"url":"https://devtest.receiptx.com/VRG/file/LoginConvertLDS?username=