{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-vas/vas.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Voucher redemption","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-redemption"},"children":["Voucher redemption"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Voucher redemptions involve the use of provisioned vouchers as tender (payment) for a specific service."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"operations-and-messages"},"children":["Operations and Messages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The table below lists the transactions that make up digital voucher redemptions and the API calls you will need to implement."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Transaction"},"children":["Transaction"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API Call"},"children":["API Call"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Voucher lookup"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/lookupvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupVoucher"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /products"]}]},{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Redeem voucher"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/redeemvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemVoucher"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /redemptions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request payload: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/redemptionrequest"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RedemptionRequest"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response payload: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/redemptionresponse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RedemptionResponse"]}]}]},{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirm voucher redemption"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/confirmredeem"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confirmRedeem"]}," "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST/redemptions/confirmations"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request payload: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicadvice"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicAdvice"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response payload: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicadvice"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicAdvice"]}]}]},{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reverse voucher redemption"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/reverseredeem"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reverseRedeem"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST/redemptions/reversals"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request payload: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicreversal"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicReversal"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response payload: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicreversal"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicReversal"]}]}]},{"$$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":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Stellr does not support advice messages (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/vas/public/advanced-topics/reversals-and-refunds"},"children":["reversals"]}," or confirmations), therefore if implemented Electrum will consume any advice messages sent to the Electrum Switch."]}]},{"$$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 redemption transactions and error scenarios."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"successful-voucher-redemption-dual-messaging"},"children":["Successful Voucher Redemption: Dual Messaging"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system performs a successful voucher lookup transaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/redemptions"]}," endpoint of the API (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/redeemvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemVoucher"]}," "]},"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/redemptionresponse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RedemptionResponse"]}]}," message payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicadvice"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicAdvice"]}]}," confirmation message via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redemptions/confirmations"]}," endpoint of the API (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/confirmredeem"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confirmRedeem"]}]}," operation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum responds immediately with a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicadvice"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicAdvice"]}]}," message payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the service provider supports ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/vas/public/advanced-topics/dual-and-single-messaging"},"children":["dual messaging"]},", Electrum sends a confirmation message to the service provider via a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/vas/public/advanced-topics/store-and-forward-queues"},"children":["store-and-forward queue"]}," until a response is returned."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/successful-voucher-redemption-dual.8866227fe4b3d4b7eba6b50b99c2072d1f5a58a3113ce1c28348d682aed191da.f0281c88.png","alt":"alt text"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"successful-voucher-redemption-single-messaging"},"children":["Successful Voucher Redemption: Single Messaging"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system performs a successful voucher lookup transaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/redemptions"]}," endpoint of the API (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/redeemvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemVoucher"]}," "]}," 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/redemptionresponse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RedemptionResponse"]}]}," message payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The consumer receives their voucher and the transaction is complete."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/successful-voucher-redemption-single.dc741aa66a44454af141b4b0576d43c76884ca73096771d675e145ffa479a3a0.f0281c88.png","alt":"alt text"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-or-timeout-at-originating-system"},"children":["Error or Timeout at Originating System"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After a successful voucher lookup transaction, the originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/redemptions"]}," endpoint of the API (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/redeemvoucher/"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemVoucher"]}," "]}," operation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An error occurs at the originating system, or a timeout occurs when the originating system does not receive a reponse."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicreversal"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicReversal"]}]}," message (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/reverseredeem"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reverseRedeem"]}]}," operation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum responds immediately with a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicreversal"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicReversal"]}]}," response message."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum sends a reversal message to the service provider – if the provider supports reversal messaging – via a store-and-forward queue until a response is returned."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/error-at-os-during-voucher-redemption.4170296f151d15079351f1de0dd941d55bb0f36270f026e9e3c3a84eb2df1640.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":["After a successful voucher lookup transaction, the originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/redemptions"]}," endpoint of the API (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/redeemvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemVoucher"]}," "]}," operation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An error occurs at 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 to the originating system and the consumer is informed of the error."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The consumer can decide whether to abort the transaction or attempt it again."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/error-upstream-during-voucher-redemption.61ee5532357fe6b352ed99fefb9267dbfd4ef851a79a465c0797b3a33d85e11a.f0281c88.png","alt":"alt text"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"timeout-upstream"},"children":["Timeout Upstream"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After a successful voucher lookup transaction, the originating system sends a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," call to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/redemptions"]}," endpoint of the API (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/redeemvoucher"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemVoucher"]}," "]},"operation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An timeout error occurs when Electrum does not receive a response from the service provider."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum returns 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 to the originating system."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The originating system sends a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicreversal"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicReversal"]}]}," message (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/other/reverseredeem"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reverseRedeem"]}]}," operation) and Electrum immediately returns a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/suv/swagger/schema/basicreversal"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BasicReversal"]}]}," response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Electrum sends a reversal message to the service provider – if the provider supports reversal messaging – via a store-and-forward queue until a response is returned."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/timeout-upstream-during-voucher-redemption.9258f0ae42c049351220d41eab99f4b374190a8e9bbd1138282a68266b6acb99.f0281c88.png","alt":"alt text"},"children":[]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You should not attempt transaction lookups until after the initial processing period concludes (after Electrum has received and processed the transaction outcome)."]}]}]},"headings":[{"value":"Voucher redemption","id":"voucher-redemption","depth":1},{"value":"Operations and Messages","id":"operations-and-messages","depth":2},{"value":"Message Flows","id":"message-flows","depth":2},{"value":"Successful Voucher Redemption: Dual Messaging","id":"successful-voucher-redemption-dual-messaging","depth":2},{"value":"Successful Voucher Redemption: Single Messaging","id":"successful-voucher-redemption-single-messaging","depth":2},{"value":"Error or Timeout at Originating System","id":"error-or-timeout-at-originating-system","depth":2},{"value":"Error Upstream","id":"error-upstream","depth":2},{"value":"Timeout Upstream","id":"timeout-upstream","depth":2}],"frontmatter":{"seo":{"title":"Voucher redemption"}},"lastModified":"2026-01-28T10:41:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/vas/public/digital-vouchers/integrate-your-channel/voucher-redemption","userData":{"isAuthenticated":false,"teams":["anonymous"]}}