Voucher Lookup

A voucher lookup transaction must be performed prior to voucher redemption of an exisiting voucher in order to access details of that voucher.

Operations and Messages

This transaction consists of a single set of messages described by the lookupVoucher operation, GET /vouchers.

• Response payload: VoucherLookupResponse
• Error payload: ErrorDetail

Message Flows

The sections below describe successful voucher lookup transactions and error scenarios.

Successful Voucher Lookup Transaction

1. The originating system sends a GET call to the /vouchers API endpoint (lookupVoucher operation).
2. The API responds with a VoucherLookupResponse message payload.
3. The originating system receives details of the voucher.

Error at Originating System

1. The originating system sends a GET call to the /vouchers API endpoint (lookupVoucher operation).
2. The API responds with a VoucherLookupResponse message payload.
3. An error is encountered at the originating system and the voucher details are not received.
4. The originating system should reattempt the lookup until a the transaction is completed successfully.

Error Upstream

1. The originating system sends a GET call to the /vouchers API endpoint (lookupVoucher operation).
2. An error is encountered at Electrum or the service provider.
3. Electrum sends an ErrorDetail message payload to the originating system.
4. No further messaging is required at the originating system, but the lookup should be reattempted until the transaction is completed successfully.