Clarification on External Portal API Support for Voucher Authentication

This thread has been locked for further replies. You can start a new thread to share your ideas or ask questions.

Clarification on External Portal API Support for Voucher Authentication

This thread has been locked for further replies. You can start a new thread to share your ideas or ask questions.
Clarification on External Portal API Support for Voucher Authentication
Clarification on External Portal API Support for Voucher Authentication
2025-06-29 09:16:31 - last edited 2025-07-01 06:35:20
Hardware Version:
Firmware Version: 5.15.24.17

Subject: Clarification on External Portal API Support for Voucher Authentication

Hi TP-Link Support,

 

I am currently integrating an external captive portal with the Omada SDN Controller (version 5.15.24.17 on Ubuntu) and would like to confirm support for voucher-based authentication via the /api/v2/hotspot/extPortal/auth/ endpoint.

 

I came across your FAQ https://www.tp-link.com/us/support/faq/2907/ which outlines the use of the external portal feature with parameters like `authType`, but it primarily focuses on external authentication.

 

However, I noticed that the `authType` field in the POST payload allows numeric values and appears to control different login types. I attempted to use `authType: 3` along with a `voucher` field in the payload (e.g., { "authType": 3, "voucher": "XXXXXX", ... }), but the API consistently returns:


{ "errorCode": -41501, "msg": "Failed to authenticate." }
 

I would like to confirm:

1. Does the Omada SDN Controller support voucher authentication via the external portal API?
2. If yes, what is the correct payload structure and `authType` value for voucher-based authentication?
3. If not supported, are there plans to expose this functionality via API in future releases?

 

I am building a solution that needs to validate vouchers externally for integration with a local payment system and hotspot gateway.

Looking forward to your clarification and assistance.

  0      
  0      
#1
Options
1 Accepted Solution
Re:Clarification on External Portal API Support for Voucher Authentication-Solution
2025-07-01 06:35:17 - last edited 2025-07-01 06:35:20

Hi  @rom27654 

 

Thanks for posting here.

 

 Unfortunately, it's not supported, and we don't have a plan to add it yet.

Recommended Solution
  0  
  0  
#2
Options
1 Reply
Re:Clarification on External Portal API Support for Voucher Authentication-Solution
2025-07-01 06:35:17 - last edited 2025-07-01 06:35:20

Hi  @rom27654 

 

Thanks for posting here.

 

 Unfortunately, it's not supported, and we don't have a plan to add it yet.

Recommended Solution
  0  
  0  
#2
Options