WPay
    • Introduction
    • Signature
    • API Keys
    • Get Started
    • Webhook Service
    • Api Reference
      • Authentication
        • Get Access Token
        • Refresh Access Token
      • WPay
        • Hosted Payment Page
        • List Payment History
        • Get Payment Detail
        • Refund
        • List Subscriptions
        • Get Subscription Detail
        • Cancel Subscription
        • Get Subscription Bills
      • Webhook
        • Simulate a Event Call
    • Schemas
      • Schemas
        • RefundOrderDTO
        • RefundPageReq
        • ApiPageApiPageRefundOrderDTO
        • ApiResponseApiPageRefundOrderDTO
        • CancelReq

    Webhook Service

    Overview#

    WPay supports callback to customer interfaces in multiple business scenarios. Customers can implement their own business logic in the callback interface.
    For webhook url configuration, please refer to API key management menu in Dashboard platform, and update the related API key info.
    The callback is based on the HTTP/HTTP protocol with the POST method, and all request bodies are in JSON format with all characters encoded in UTF-8.
    The callback process is considered Failed if any of the following situations occur: request failed, request timeout, or response status code other than 2XX.
    The callback is divided into Synchronous and Asynchronous types, Synchronous request must respond in a timely manner and have no try mechanism, while asynchronous requests do not need to respond in a timely manner and have a retry maechanism.
    Upon receiving the callback, kindly respond with SUCCESS; otherwise, a retry will be triggered.
    NameResponse TimeRetry countRetry Interval
    OPENAPI_WEBHOOK15s1415,15, 30, 180, 600, 1200, 1800,1800,3600,10800,10800,10800,21600,21600

    Webhook Data Example#

    "data" : {
        "id" : 241221140404158,
        "event" : "executor_success",
        "requestId" : "d3a4e1f0-9b2c-4d5e-8f3a-1b2c3d4e5068",
        "status" : "Completed",
        "amount" : "100.00",
        "reallyAmount" : "99.40",
        "currency" : "USD",
        "clientId" : "600001894",
        "remark" : "This will be shown in your bank statement for reconciliation",
      }
    FieldTypeDescription
    idLong
    clientIdLong
    eventString
    requestIdString
    statusString
    amountString
    realAmountString
    currencyString
    remarkString
    Modified at 2026-05-17 22:59:32
    Previous
    Get Started
    Next
    Get Access Token
    Built with