{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-vas/vas.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Voucher Lookup","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"voucher-lookup"},"children":["Voucher Lookup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A voucher lookup transaction must be performed prior to voucher redemption of an exisiting voucher in order to access details of that voucher."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"operations-and-messages"},"children":["Operations and Messages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This transaction consists of a single set of messages described by the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/lookupvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupVoucher"]}]}," operation, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /vouchers"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response payload: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/voucherlookupresponse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VoucherLookupResponse"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Error payload: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/errordetail"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorDetail "]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"message-flows"},"children":["Message Flows"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The sections below describe successful voucher lookup transactions and error scenarios."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"successful-voucher-lookup-transaction"},"children":["Successful Voucher Lookup Transaction"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/vouchers"]}," API endpoint (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/lookupvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupVoucher"]}]}," operation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The API responds with a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/voucherlookupresponse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VoucherLookupResponse"]}]}," message payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system receives details of the voucher."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/successful-voucher-lookup-phase-1.9e587f8874568dd9e8b3ffc15d8b184ac2d62de9ca8f1b2e61548e98b620ce37.f0281c88.png","alt":"alt text"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-at-originating-system"},"children":["Error at Originating System"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/vouchers"]}," API endpoint (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/lookupvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupVoucher"]}]}," operation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The API responds with a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/voucherlookupresponse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VoucherLookupResponse"]}]}," message payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An error is encountered at the originating system and the voucher details are not received."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system should reattempt the lookup until a the transaction is completed successfully."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/error-at-os-during-voucher-lookup-phase.a047ae5e1c340763731d45357fad89bcf7ba03bba9f8fa31e08f8baa53901ce0.f0281c88.png","alt":"alt text"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-upstream"},"children":["Error Upstream"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/vouchers"]}," API endpoint (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/lookupvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupVoucher"]}]}," operation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An error is encountered at Electrum or the service provider."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum sends an ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/errordetail"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorDetail "]}]}," message payload to the originating system."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["No further messaging is required at the originating system, but the lookup should be reattempted until the transaction is completed successfully."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/error-at-sp-during-voucher-lookup-phase-1.9d62feffb3c1e80f16affb007e260583875b5dedc212b37b1349d3ecd8742be4.f0281c88.png","alt":"alt text"},"children":[]}]}]},"headings":[{"value":"Voucher Lookup","id":"voucher-lookup","depth":1},{"value":"Operations and Messages","id":"operations-and-messages","depth":2},{"value":"Message Flows","id":"message-flows","depth":2},{"value":"Successful Voucher Lookup Transaction","id":"successful-voucher-lookup-transaction","depth":3},{"value":"Error at Originating System","id":"error-at-originating-system","depth":2},{"value":"Error Upstream","id":"error-upstream","depth":2}],"frontmatter":{"seo":{"title":"Voucher Lookup"}},"lastModified":"2026-01-28T10:41:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/vas/public/digital-vouchers/integrate-your-channel/voucher-lookup","userData":{"isAuthenticated":false,"teams":["anonymous"]}}