This endpoint retrieves the current status of a specific voucher using its voucher code. The response includes information about whether the voucher is active, used, expired, or invalid, along with details such as value, expiry date, and redemption history if applicable.

Request

Method: GET
URL: /v2/vouchers/status/{voucherCode}
Path Parameters:

• voucherCode (string, required) – The voucher code to check status for.

Query Parameters: None
Body: None
Notes: This request is read-only and does not affect the voucher state.

Responses

200 OK – Successful

Field Descriptions:

• data (object) – Voucher status information.
  • status (string) – Current voucher status (e.g., ACTIVE, USED, EXPIRED, INVALID).
  • value (number) – Voucher value.
  • expiryDate (string) – Voucher expiry date.
• statusCode (string) – Provider-specific status code ("00" indicates success).
• message (string) – Human-readable message indicating the outcome.

401 Unauthorized

Returned when the request is not authorized.

Unauthorized

403 Forbidden

Returned when the user does not have permission to access this resource.

Forbidden

404 Not Found

Returned when the voucher code is not found.

Voucher not found

500 Internal Server Error

Returned when the server encounters an unexpected condition.

Internal Server Error

Example cURL Request

curl -X GET \
  'https://{baseUrl}/v2/vouchers/status/123456789' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'