Dispute created

Event GroupEvent Identification
paymentspayments/create
Occurs whenever a dispute is created.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • 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
  • detailobject
    Dispute details.
  • amount string
    Dispute amount. The value is rounded to two decimal places.
  • channel_dispute_id string
    The dispute ID from the payment channel used by SHOPLINE Payments.
  • create_time string
    Dispute creation time. Format: ISO 8601.
    Example: 2025-06-01T00:00:00+08:00
  • currency string
    Dispute currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. Example: USD.
  • dispute_evidence_update_deadline string
    Deadline for the merchant to submit evidence. Format: ISO 8601.
    Example: 2025-06-02T00:00:00+08:00
  • dispute_id string
    The unique identifier for the dispute.
  • dispute_type string
    Dispute type. Valid values are:
    • CHARGEBACK: Customers have filed transaction disputes with their banks, and the disputed amounts will be temporarily withheld during the investigation.
    • PRE_CHARGEBACK: This is the preliminary stage before a full CHARGEBACK, where the issuing bank investigates the dispute.
    • RETRIEVAL: The acquiring bank has requested the merchant to provide additional information regarding this transaction.
    • FRAUD_NOTIFICATION: The transaction is potentially fraudulent.
  • exchangeobject
    Foreign exchange information.
  • amount string
    The amount of foreign exchange based on the actual payment amount. The value is rounded to two decimal places.
  • currency string
    Exchange currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. Example: USD.
  • rate string
    Exchange rate, in the format of {dispute currency}/{exchange currency} @{rate}. The rate is rounded to 10 decimal places.
    Example: USD/USD @1.0000000000
  • fee string
    Transaction fees. If SHOPLINE Payments charges a fee to the merchant, this field is displayed as a negative amount. If SHOPLINE Payments refunds a fee to the merchant, this field is displayed as a positive amount.
  • fee_type string
    Fee type. Valid values are:
    • domestic: Local transaction fee, the fee for accepting domestic bank card transactions.
    • international: Cross-border transaction fee, the fee for accepting foreign bank card transactions.
  • payment_method string
    Payment method.
  • reason string
    The reason for the dispute. When dispute_type is CHARGEBACK, the valid values are:
    • fraudulent: The transaction was fraudulent.
    • unrecognized: The transaction is suspicious.
    • duplicate: The customer was charged twice for the same item or service.
    • subscription_canceled: The customer canceled a subscription but was still billed.
    • product_not_received: The customer did not receive the purchased product.
    • product_unacceptable: The customer received the product but was dissatisfied with it.
    • credit_not_processed: The customer was promised a refund but never received it.
    • general: Other reasons.
    When dispute_type is PRE_CHARGEBACK, RETRIEVAL, or FRAUD_NOTIFICATION, the value of this field is non-enumerated.
  • seller_order_id string
    Business order number.
  • status string
    Dispute status.
    When dispute_type is CHARGEBACK, the valid value is:
    • CREATED: The dispute has been initiated.
    When dispute_type is PRE_CHARGEBACK, the valid value is:
    • PRE_CHARGEBACK_CREATED: A pre-chargeback has been initiated. Per the regulations of some card schemes, the system will not issue an automatic refund. The merchant needs to decide whether to accept or reject the refund request.
    When dispute_type is RETRIEVAL, the valid value is:
    • RETRIEVAL_CREATED: A retrieval request has been submitted.
    When dispute_type is FRAUD_NOTIFICATION, the valid value is:
    • FRAUD_FINISHED: Notification of potential fraudulent activity. The merchant should hold the shipment and contact the customer to verify the order, and consider issuing a refund to avoid a future chargeback.
  • trade_order_id string
    The unique identifier for the original payment.
  • update_time string
    Dispute detail update time. Format: ISO 8601. Updates include changes to dispute status.
    Example: 2025-06-01T00:00:00+08:00
  • event_id string
    The unique identifier for the dispute event. Use this as the idempotency key to avoid duplicate processing.
  • event_type string
    Event type. Fixed value: slp_dispute/create.
  • store_id string
    Store ID.
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?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.