Skip to main content
POST
Order refund

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

refundReason
string
required

Refund reason

Maximum string length: 256
Example:

"replace your reason...."

merchantRefundOrderId
string

Merchant side refund order id

Maximum string length: 64
refundAmount
string

Refund amount in order currency, tax-exclusive. Provide it to refund by the tax-exclusive amount. It may be omitted only when the original order was placed with a tax-inclusive price and you instead pass taxInfo.refundAmountInclTax (the tax-inclusive refund amount), from which Waffo derives this tax-exclusive amount.

Maximum string length: 24
Example:

10

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

taxInfo
object

Merchant tax input (order currency). Type② passes refundAmountInclTax paired with top-level refundAmount; tax = inclusive − exclusive is derived.

Response

200 - */*

OK

response data

code
string
Example:

0

msg
string
Example:

"success"

data
object