2025-01-20
  • 2025-03-25
  • 2025-01-20
  • 2022-03-14
Help Center
VCCHUB How-to
2025-01-20
  • 2025-03-25
  • 2025-01-20
  • 2022-03-14
  1. API Reference
  • Guides
    • Welcome
    • Interface
  • API Reference
    • Introduction
    • Endpoints
    • Data Types
    • Signing
    • Errors
    • Webhooks
    • Items Information
    • Changelog
    • Acquiring
      • Create a direct payment
        POST
      • Create a redirect (iFrame) payment
        POST
      • Capture a transaction
        POST
      • Review a transaction
        POST
      • Cancel a transaction
        POST
      • Query a transaction
        POST
      • Refund a transaction
        POST
      • Search a refund transaction
        POST
      • Create a payout
        POST
      • Optimise payment methods
        POST
      • Update an order
        POST
    • Issuing
      • Cardholder
        • Create cardholder
          POST
        • Delete cardholder
          POST
        • Query cardholder
          POST
      • Card
        • Query card BIN
        • Create a card
        • Query card details
        • Recharge card
        • Withdraw from a card
        • Cancel a card
        • Update card status
        • Update card limit
  • Appendix
    • Test Cards
    • Bank Code
    • Country Code
    • Currency Code
    • Payment Methods
  1. API Reference

Introduction

Welcome to Star SaaS.
Our flexible SaaS API gives you full control over currency conversions, payments, and account management. Built around REST, the API uses predictable resource-oriented URLs, form-encoded request bodies, JSON-encoded responses, and follows standard HTTP response codes, authentication, and verbs.
We highly recommend reviewing the full API documentation to understand the product's features and workflows. Demo account access can be provided for testing.
You can operate the Star SaaS API in test mode, ensuring no impact on live data or interaction with payment systems. The API key, combined with the endpoint URL, determines whether requests are in live or test mode.

💡

Definitions
ParametersDescription
Merchant CodeUnique Merchant ID, also known as Merchant Number.
Account IDSub account assigned under merchant account, also known as subaccount ID, gateway number.
Secret KeyParameter name "sign_key", key generated for each Account_id.
Return URLParameter name: "return_url". A merchant customized HTTP URL where the payment result message will be returned to after a payment process is finished (for Redirect interface).
Notify URLParameter name: "notify_url". A merchant customized HTTP URL where the notifications will be sent to.

Previous
Interface
Next
Endpoints