Skip to main content

API Documentation Introduction

Welcome to the VP API documentation. This documentation provides complete API specifications for two wallet modes.

👉 Seamless Wallet: View Documentation
👉 Transfer Wallet: View Documentation

General Notes​

Security Requirements​

  1. HTTPS Required

    • All API requests must use HTTPS protocol
    • Ensure SSL certificate is valid and not expired

  2. Encrypted Transmission

    • Sensitive data must use AES-256-GCM encryption
    • Keep encryption keys secure and avoid leakage

  3. Signature Verification

    • Each request must include a valid signature
    • Use SHA256 algorithm for signature verification

  4. Token Management

    • JWT Token is valid for 24 hours
    • Token must be reacquired after expiration
    • Do not pass Token in URL

Request Specifications​

  1. Request Header Settings

    Content-Type: application/json
    Authorization: Bearer {token}

  2. Character Encoding

    • Use UTF-8 encoding universally
    • Special characters require URL encoding

  3. Time Zone Setting

    • All time parameters use UTC+0 time zone
    • Except for x-timestamp in the header which uses millisecond Unix timestamp, all other API time formats must use the ISO 8601 standard YYYY-MM-DDTHH:mm:ss.SSSZ format (e.g.: 2026-02-02T10:30:00.000Z)

Error Handling​

  1. Idempotency

    • Use unique "Transaction ID" and "Bet ID" to ensure idempotency
    • Duplicate requests will not result in duplicate deductions

  2. Error Codes

    • For detailed error codes, please refer to the Error Appendix for each wallet mode
    • Seamless Wallet: Error Appendix
    • Transfer Wallet: Error Appendix

Test Environment​

  1. Test Account
  • Please Contact Customer Support Team to obtain a test environment account
  • The test environment is completely isolated from the production environment
  1. Test Key
  • The test environment uses an independent API key
  • It needs to be replaced with a production environment key before going live
  1. Test Data
  • Test environment data will not be synchronized to the production environment

Technical Support​

If you encounter problems during implementation, please Contact Customer Support Team and include the UUID from the Headers or Response for easier issue tracking.

Quick Start​

  1. Choose Wallet Mode - Choose Seamless Wallet or Transfer Wallet based on business needs
  2. Obtain API Key - Contact Customer Support Team to obtain a test environment key
  3. Read Documentation - Read the API Documentation for the corresponding wallet mode in detail
  4. Test Integration - Complete API integration in the test environment
  5. Go Live Deployment - Apply for the production environment and then deploy to go live

Additional Recommendations​

Screen Wake Lock Permission Description (Screen Wake Lock)​

  • Enable screen wake lock to prevent the device screen from dimming or turning off automatically. When using an <iframe\> to embed a service page, you must explicitly declare the permission policy, otherwise the browser will block the function for security reasons.
<iframe 
  id="vp-service-monitor" 
  src="https://api.example.com/v1/monitor" 
  allow="screen-wake-lock"
  style="width: 100%; height: 600px; border: none;">
</iframe>

Last Updated: 2026-03-24