GET api/Purchase/{affiliateId}/VerifyVoucher/{voucherCode}?collectionId={collectionId}
Voucher verification
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| affiliateId |
Affiliate Id |
integer |
Required |
| voucherCode |
Whole code including dash if it is two part code |
string |
Required |
| collectionId |
Id of collection to validate bundle offer |
string |
None. |
| v |
The requested API version |
string |
Default value is 2.0 |
Body Parameters
None.
Response Information
Resource Description
Voucher verification
FilmFlex.Platform.Common.API.Contracts.V2.VerifyVoucherDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Value |
Value of the voucher |
decimal number |
None. |
| RedeemableValue |
Redeemable Value of the voucher |
decimal number |
None. |
| Status |
Voucher verification status |
FilmFlex.Platform.Common.API.Contracts.V2.VoucherVerificationStatusDTO |
None. |
| StatusMessage |
Voucher verification status description |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Value": 1.0,
"RedeemableValue": 2.0,
"Status": 0,
"StatusMessage": "sample string 3"
}