Skip to main content
POST
/
api
/
v1
/
order
/
refund
Order refund
curl --request POST \
  --url https://www.waffo.com/api/v1/order/refund \
  --header 'Content-Type: application/json' \
  --data '
{
  "refundRequestId": "<string>",
  "acquiringOrderId": "<acquiringOrderId>",
  "merchantId": 1000000201,
  "requestedAt": "2023-11-07T05:31:56Z",
  "refundAmount": 10,
  "refundReason": "replace your reason....",
  "merchantRefundOrderId": "<string>",
  "refundNotifyUrl": "<string>",
  "extendInfo": "<string>",
  "refundSource": "<string>"
}
'
{
  "code": "<string>",
  "msg": "<string>",
  "data": {
    "refundRequestId": "<string>",
    "acquiringOrderId": "<string>",
    "acquiringRefundOrderId": "<string>",
    "refundAmount": "<string>",
    "refundStatus": "<string>",
    "remainingRefundAmount": "<string>",
    "refundSource": "<string>",
    "merchantRefundOrderId": "<string>"
  }
}

Body

application/json
​
refundRequestId
string
required

Refund request id sent from Merchant. It will also be used for idempotent check.

Maximum string length: 32
​
acquiringOrderId
string
required

Waffo acquiring order Id

Maximum string length: 32
Example:

"<acquiringOrderId>"

​
merchantId
string
default:1000000201
required

Merchant Id assigned by Waffo

Maximum string length: 64
Example:

1000000201

​
requestedAt
string<date-time>
required

Merchant-side request time

​
refundAmount
string
required

Refund amount

Minimum string length: 1
Example:

10

​
refundReason
string
required

Refund reason

Maximum string length: 256
Example:

"replace your reason...."

​
merchantRefundOrderId
string

Merchant side refund order id

Maximum string length: 64
​
refundNotifyUrl
string

The callback address to notify the merchant after the refund is completed / failed. If not provided, Merchant can use inquiry refund API to get the final refund status.

Maximum string length: 256
​
extendInfo
string

Reserved. Json format e.g. {"key1":"value1", "key2":"value2"}

Maximum string length: 128
​
refundSource
string
​
userInfo
object

For certain pay method type (e.g. ONLINE_BANKING) the refund requires Merchant to provide user information to execute

Response

200 - */*

OK

response data

​
code
string
​
msg
string
​
data
object