Appearance
POST
/estore/voucher/_lookupRequired scope:
viskan:voucher:readLooks up a voucher at the third party service provider without reserving anything on it and without adding it to a shopcart.
When the voucher cannot be used the response is a 400 carrying one of the following error codes:
voucher.lookup.no-voucher-found: no voucher exists with the given numbervoucher.lookup.expired: the voucher has passed its valid to datevoucher.lookup.no-funds-left: the voucher has no amount left on itvoucher.lookup.not-started: the period of the voucher has not yet startedvoucher.lookup.verification-code-required: the provider requires a verification code, but none was givenvoucher.lookup.verification-code-incorrect: the given verification code was incorrectvoucher.lookup.verification-code-not-required: a verification code was given, but the provider does not use onevoucher.lookup.no-payment-method-found: no payment method exists with the given id for the store and countryvoucher.lookup.payment-method-does-not-handle-vouchers: the payment method is not connected to a voucher providervoucher.lookup.unknown-error: the provider rejected the voucher for a reason it did not specify
Request body
JSON
{
"countryCode": "...",
"maxAmount": 199.99,
"parameters": {
"property1": "...",
"property2": "..."
},
"paymentMethodId": 12345,
"shopcartId": "...",
"verificationCode": "...",
"voucherNumber": "..."
}
Response
The voucher was found.
JSON
{
"amountAvailable": 12345,
"comment": "...",
"validTo": "...",
"voucherNumber": "..."
}