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

Webhooks

A webhook URL can be provided as a request parameter in the request body for certain endpoints, allowing you to receive notifications when the status of an underlying object changes.
This eliminates the need to schedule tasks or constantly poll Star SaaS’s endpoints for updates. Simply include a webhook_url in the API payload, and Star SaaS will send a POST request to your server whenever there is a status change in the object. Ensure that the webhook_url is set to HTTPS, as webhooks will not be triggered over unencrypted connections.
It’s essential to configure your endpoint URL to acknowledge Star SaaS's webhooks with standard HTTP response codes. For example, return a 2xx code to confirm the successful receipt of a POST request on your server.
If Star SaaS does not receive a 2xx acknowledgement, it will retry sending the webhook for up to 36 hours as detailed in the retry policy below.
The following Star SaaS objects trigger webhook responses:
Review
Chargeback
Payment
Refund
The webhook subscription can also be requested in the Dashboard, with the following types available:
PAYMENT
REVIEW RESULT
DISPUTE RECIEVED
DISPUTE RESULT
REFUND RECIEVED
REFUND ACCEPTED
REFUND RESULT
Not receiving webhooks?
In case of any server block or not receiving a response to your webhook URL, try whitelisting the below IP addresses:
Test Mode (Sandbox) : XX.XXX.XXX.XXX
Live Mode (Production) : XX.XXX.XXX.XXX

Retry Policy#

If Star SaaS does not receive a 2xx status from your endpoint as an acknowledgement of successful webhook delivery, it keeps retrying.
The time between each retry increases exponentially by a power of 2 with jitter till a period of 12 hours. The first retry starts after 1 second of original webhook delivery.
This process is repeated 3 times. You can receive a retried webhook upto 36 hours from the delivery of the first webhook.

Review#

Review notifications will be sent to the notify_url defined by merchant, in the format of NameValuePair. Below are the notification parameters:
Review

Chargeback#

Chargeback notifications will be sent to the notify_url defined by merchant, in the format of NameValuePair. Below are the notification parameters:
Chargeback

Payment#

For offline payment such as offline bank transfers, our gateway system will notify merchant with the final result via payment notification once payment is completed. These notifications will send to the ‘notify_url’ defined by merchant in HTML format via POST method.
Below are the parameters of payment notification
Payment

Refund#

Refund notifications will be sent to the notify_url defined by merchant, in the format of NameValuePair. Below are the notification parameters:
Refund

Previous
Errors
Next
Items Information