# 1.2 Get Refund Payments Api
# Description
- Get Refund Payments Api
# Request URL
/api/refund/payments
# Request Method
- GET
# Request Parameters
parameter name | is it mandatory | type of data | length | description |
---|---|---|---|---|
appId | mandatory | string | - | APPID |
originalTransactionId | optional | string | 20 | Original Transaction Id(Either the original transaction id or the refund transaction id is optional.) |
refundTransactionId | optional | string | 20 | Refund Transaction Id(Either the original transaction id or the refund transaction id is optional.) |
sign | mandatory | string | - | sign |
# Successful Response example
{
"code": 1000,
"message": "success",
"data": [
{
"mchRefundOrderId": "CCP20220428011068111",
"originalTransactionId": "C4X20220428011068485",
"refundTransactionId": "R2022042801106815674",
"refundAmount": 10000,
"feeRefunded":1000,
"refundStatus": "FAILED",
"refundCreateTime": "2024-04-17 18:12:46",
"refundReturnTime": "2024-04-17 18:14:05",
"refundReason": "refund reson",
"failedCode": -10009,//Response if refund failed
"failedMessage": "Channel Refund Failed"//Response if refund failed
}
]
}
# failed response example. code see reference
{
"code":1002,
"message":"merchant white ip forbidden",
}