1. Webhook
Sipay API Documentation
  • Overview
    • Getting Started
  • Authentication
    • Generating Token
      POST
  • Installments
    • Getting Installment Information
      POST
    • Installments
      POST
  • Commissions
    • Commission
      POST
  • HASH
    • Hash Information
  • Non Secure Payment
    • Non-Secure Payment Flow
    • Non-Secure Card Payment
      POST
    • Non-Secure Recurring Payment
      POST
    • Non-Secure Insurance Payment
      POST
    • Non-Secure Pre-Authorization Payment
      POST
  • 3D Secure Payment
    • 3D Secure Payment Flow
    • 3D Secure Card Payment
      POST
    • 3D Secure Recurring Payment
      POST
    • 3D Secure Pre-Authorization Payment
      POST
    • 3D Secure Agriculture Payment
      POST
  • Payment
    • Check Status
      POST
    • Confirm Payment
      POST
    • Complete Payment
      POST
    • Non-Secure and 3D Payment with Sipay
      POST
    • Refund
      POST
  • Payment with Saved Card
    • Card Registration
    • Pay by Card Token
    • Retrieving Saved Card
    • Edit Saved Card
    • Delete Saved Card
    • Non-Secure Payment with Hidden Card
  • Recurring
    • Recurring Query Search
    • Recurring Plan Process
    • Recurring Plan Update
  • Cashout
    • Cashout to Bank
  • Webhook
    • Webhook
  • Status Codes
    • Status Codes
  1. Webhook

Webhook

Recommended approach involves using webhooks to receive real-time notifications for system events.
Webhooks provide a mechanism for delivering event-based updates directly to the merchant system without the need for continuous polling.
Event types such as successful payments, refunds, chargebacks, or subscription updates are delivered in real time via HTTP POST requests containing structured payload data.
A webhook URL must be registered in order to receive these notifications.
This configuration is performed through the Sipay merchant panel: Here.
To enable this functionality, the sale_web_hook_key must be included in the purchase request.
This key is optional; however, when provided, a valid and correctly configured key is required for the webhook process to be activated.
Webhook responses should be handled securely and validated to ensure data integrity. Proper acknowledgement of received events is recommended to prevent duplicate processing and to maintain synchronization between the merchant system and Sipay services.
Example Webhooks :
Sale Webhook
Refund Webhook
Recurring Webhook
Modified at 2026-04-20 14:12:12
Previous
Cashout to Bank
Next
Status Codes
Built with