# 1.4 Refund Notification

# HTTP request info

# URL

Provided by merchant.

# Method

POST

# Content-Type

application/json

# Request Body

Parameter Name Required Type Description
param Y string param
sign Y string signature

# param

Parameter Name Required Type Description
eventName Y string Event name (payment.refund.success, payment.refund.failed, payment.refund.cancel)
mchRefundOrderId Y string Merchant refund order id (unique for customer) format: letter + num, 1-32 characters: CCP20220428011068111
refundTransactionId Y string PayCools Refund Transaction ID
originalTransactionId Y string PayCools Origin Transaction ID
refundAmount Y int Refund Amount
feeRefunded Y int Fee Refunded
refundStatus Y string Refund Status
refundCreateTime Y string Refund Create Time
refundReturnTime Y string Refund Return Time
refundReason Y string Refund Reason
failedCode N int Failed Code(Value present on failure.)
failedMessage N int Failed Message(Value present on failure.)

# Request Example

# Request Body

{
  "param": "{\"eventName\":\"payment.refund.success\",\"mchRefundOrderId\":\"18184914989277184\",\"originalTransactionId\":\"CU508022434763373688\",\"refundAmount\":10000,\"feeRefunded\":1000,\"refundCreateTime\":\"2024-07-31 11:38:54\",\"refundReturnTime\":\"2024-07-31 11:38:55\",\"refundStatus\":\"COMPLETE\",\"refundTransactionId\":\"1818491499290169344\"}",
  "sign": "W3j7iWptU5CDfXAAl9URzBzb2NpEaBTP4wnYTsv2XFuN70m+SJnlPVpByM7OR5w/zGQWAzmJGIYgJeNwPQDHzP24MPQDtWjPVIMPvzqlTNC2SKnzbhTPCjt3B8cgLc2o/oBhQ6nA9itk0A9lnhe5ZdOZnbOZmIO9Lq2VTEAG6lda5rEK7ycvGEp0t+MnC5rKYJsKS8OWklnB9oRnxd+vNLw+yOGGIExdn1WFrNnQnsNl86sqx7+NdBu0gK/EEvqhWAW+WronOS5I61ymSKNk4d3IGQxflgCsMsPQRBgU8Q6lnCflci7bMeT2gz3zevPZDXFxbtdg2PkEeWKHBXWg=="
}

How Platform construct request body


# Response Param

Paramter Name Type Description
code integer Response code, fixed value 10000
message string Response message, fixed value Success

# Response Example

{
  "code": 10000,
  "message": "Success"
}