Event GroupEvent Identification
checkout_paymentcheckout_payment/update
When the status changes in the payment slip of checkout , an event will be sent
Request Headers
  • X-Shopline-Topic string required
    The unique identifier for the event.
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    The store domain.
    Example: example.myshopline.com
  • X-Shopline-Shop-Id string required
    The store ID.
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    The merchant ID.
    Example: 2000001234
  • X-Shopline-API-Version string required
    The API version.
    Example: v20250601
  • X-Shopline-Webhook-Id string required
    The ID of this Webhook event.
    Example: b54557e48a5fbf7d70bcd043
Request Body
  • amount double
    Payment amount
  • checkout_id string
    Guanlian logo for associated checkout
  • checkout_token string
    Guanlian for associated checkout
  • created_at string
    Creation time
    Example: 2024-08-31T02:20:26+08:00
  • currency string
    Payment currency
  • error_info string
    If payment fails , error message will be included
    Example: { errorCode : payment error code , channelCode : payment channel error code , channelMsg : payment channel error reason }
  • gateway string
    Payment gateway name
  • id string
    Jiezhang logo for checkout payment slip
  • payment_method_name string
    Payment method name
  • processed_at string
    Finish time
    Example: 2024-08-31T02:20:26+08:00
  • status string
    Payment slip status : init : payment initial state , processing : payment , not return clear results , fail : payment failure , ready : payment completed
  • transaction_id string
    Id for associated transaction list
  • update_at string
    Update time
    Example: 2024-08-31T02:20:26+08:00
Status Codes
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OK
For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?