Dispute updated
| Event Group | Event Identification |
|---|---|
| payments | payments/update |
Occurs whenever a dispute is updated.
Request Headers
- Content-Type string requiredThe field must be set to the fixed value
application/json; charset=utf-8. - X-Shopline-Topic string requiredEvent operation identificationExample:
orders/edited - X-Shopline-Hmac-Sha256 string requiredSignatureExample:
XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM= - X-Shopline-Shop-Domain string requiredShop domainExample:
shophub.myshopline.com - X-Shopline-Shop-Id string requiredShop IDExample:
1610418123456 - X-Shopline-Merchant-Id string requiredMerchant IDExample:
2000001234 - X-Shopline-API-Version string requiredVersionExample:
v20210901 - X-Shopline-Webhook-Id string requiredMessage IDExample:
b54557e48a5fbf7d70bcd043
Request Body
detailobject
Dispute details.amount stringDispute amount. The value is rounded to two decimal places.channel_dispute_id stringThe dispute ID from the payment channel used by SHOPLINE Payments.currency stringDispute currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. Example:USD.dispute_evidence_update_deadline stringDeadline for the merchant to submit evidence. Format: ISO 8601.Example:2025-06-02T00:00:00+08:00dispute_id stringThe unique identifier for the dispute.dispute_type stringDispute 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 fullCHARGEBACK, 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 stringThe amount of foreign exchange based on the actual payment amount. The value is rounded to two decimal places.currency stringExchange currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. Example:USD.rate stringExchange rate, in the format of{dispute currency}/{exchange currency} @{rate}. The rate is rounded to 10 decimal places.Example:USD/USD @1.0000000000fee stringTransaction 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 stringFee 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 stringPayment method.reason stringThe reason for the dispute. Whendispute_typeisCHARGEBACK, 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.
Whendispute_typeisPRE_CHARGEBACK,RETRIEVAL, orFRAUD_NOTIFICATION, the value of this field is non-enumerated.seller_order_id stringBusiness order number.status stringDispute status.Whendispute_typeisCHARGEBACK, the valid values are:EVIDENCE_RETURNED: Evidence submitted by the merchant was returned due to being incomplete or insufficient. The merchant needs to resubmit evidence.EVIDENCE_REQUIRED: SHOPLINE Payments requests additional evidence from the merchant.MERCHANT_SUBMITTED: The merchant has submitted evidence for review.RESOLVED: The dispute is resolved but requires further action to determine the final outcome (eitherWONorLOST).CANCELED: The dispute was cancelled, likely leading to aWONoutcome for the merchant.EVIDENCE_UNDER_REVIEW: SHOPLINE Payments is reviewing the evidence submitted by the merchant.LOST: The dispute was resolved in favor of the customer, with funds being returned to the customer.WON: The dispute was resolved in favor of the merchant. Merchant retains funds.EXPIRED: The dispute expired due to inactivity. This likely leads to aLOSToutcome for the merchant.SLP_EXPIRED: The merchant failed to provide evidence within the allotted time. This likely results in anEXPIREDdispute.ACCEPTED: The merchant's dispute acceptance has been submitted to the card association. This leads to aLOSToutcome for the merchant.MERCHANT_ACCEPTED: The merchant's dispute acceptance is pending submission to the card association. This leads to anACCEPTEDoutcome for the customer.
Whendispute_typeisPRE_CHARGEBACK, the valid values are:PRE_CHARGEBACK_IN_ACCEPT: This is an intermediate status indicating the merchant has accepted the refund, either manually or through an automated rule. It will progress toPRE_CHARGEBACK_ACCEPTED.PRE_CHARGEBACK_IN_REJECT: This is an intermediate status where the merchant has chosen to reject the refund request. It will progress toPRE_CHARGEBACK_REJECTED.PRE_CHARGEBACK_IN_EXPIRE: This is an intermediate status where the merchant did not respond to the pre-chargeback within the allotted time. The case will be automatically resolved as eitherPRE_CHARGEBACK_ACCEPTEDorPRE_CHARGEBACK_REJECTEDbased on predefined rules.PRE_CHARGEBACK_ACCEPTED: The merchant accepted the pre-chargeback and initiated a refund. This is a terminal status.PRE_CHARGEBACK_REJECTED: The merchant rejected the pre-chargeback, potentially leading to further action, such as a chargeback. This is a terminal status.
Whendispute_typeisRETRIEVAL, the valid values are:RETRIEVAL_FINISHED: The retrieval was completed successfully.RETRIEVAL_CANCELED: The retrieval request was cancelled.
trade_order_id stringThe unique identifier for the original payment.update_time stringDispute detail update time. Format: ISO 8601. Updates include changes to dispute status.Example:2025-06-01T00:00:00+08:00- event_id stringThe unique identifier for the dispute event. Use this as the idempotency key to avoid duplicate processing.
- event_type stringEvent type. Fixed value:
slp_dispute/update. - store_id stringStore ID.
Status Codes
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OKFor more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?