# 1.2 Get Refund Payments

# Request URL

  • {domain}/open-api/refund/payments

# Request Method

  • POST

# Request Header

Parameter Name Required Type Description
Content-Type mandatory string application/json

# Request Body Param

Parameter Name Required Type Description
appId Y string Application Id
param Y string param
sign Y string signature

# param

Parameter Name Required Type Length Example Description
originalTransactionId N string 1-32 CCP20220428011068111 Original transaction id(Either the original transaction id or the refund transaction id is optional.)
refundTransactionId N string 1-32 CCP20220428011068111 Refund transaction id(Either the original transaction id or the refund transaction id is optional.)
timestamp Y long - 1677495496979 timestamp

# Request Example

# Request Body

{
  "appId": "733b887a4a784708bb369524db5b6ded",
  "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
  "param": "{\"originalTransactionId\":\"CU518563189147832320\",\"timestamp\":1722416882}"
}

How to construct request body


# Response Param

Parameter Name Type Description
code integer response code
message string response message
data Object data

# data(List)

参数名 类型 说明
mchRefundOrderId string Merchant refund order id (unique for customer)
originalTransactionId string Original transaction id
refundTransactionId string Platform refund transaction id
refundAmount Long Refund amount (Unit is in cents)
feeRefunded Long Fee refunded (Unit is in cents)
refundStatus string Refund status
refundCreateTime string Refund create time
refundReturnTime string Refund complete time
failedCode int Fail code(Value present on failure.)
failedMessage string Fail message(Value present on failure.)

# Response Example

{
  "code": 10000,
  "message": "Success",
  "data": [
    {
      "mchRefundOrderId": "refund7806664227088",
      "originalTransactionId": "CU51856318914782320",
      "refundTransactionId": "1818563941756964864",
      "refundAmount": 10000,
      "feeRefunded": 1000,
      "refundStatus": "FAILED",
      "refundCreateTime": "2024-07-31 16:26:46",
      "refundReturnTime": "2024-07-31 16:26:48",
      "failedCode": -10010,
      "failedMessage": "Channel Refund Failed"
    },
    {
      "mchRefundOrderId": "refund4884505715830",
      "originalTransactionId": "CU51856318914782320",
      "refundTransactionId": "1818566685947465728",
      "refundAmount": 10000,
      "feeRefunded": 1000,
      "refundStatus": "COMPLETED",
      "refundCreateTime": "2024-07-31 16:37:40",
      "refundReturnTime": "2024-07-31 17:07:40"
    }
  ]
}

Code Collection

# Failed Response Example

{
  "code": 21016,
  "message": "Merchant ip forbidden"
}