Refund Webhook

The refund webhook is sent when the status of the refund transaction changes.
Refer below for the sample payload.

{
    "refund_date": "2024-09-26 10:42:24.650023 +0000 UTC",
    "refund_id": "oKYR4vZ7ddvEAbfm9U9w2c",
    "psp_refund_id": "281m16unk3u60obtagljvxhyn",
    "amount": 500,
    "currency": "JPY",
    "refund_status": "SUCCESS",
    "refund_type": "full",
    "refund_reason": "duplicate",
    "merchant_id": "6539",
    "description": "Refund for transaction oKYR4vZ7ddvEAbfm9U9w2c",
    "payment_txn_ref": "2mbZeehV4ZhkLTwVcL2fHukBg4J",
    "payment_channel": "KOMOJU",
    "payment_method": "Alipay wallet via KOMOJU"
}

📘

Info

During testing you can use FOSS Webhook server to setup a webhook endpoint. Create a sample webhook endpoint at webhook.site

Parameter list

refund_date

string

The date and time when the refund was created

refund_id

string

The unique ID of the refund provided by merchant

psp_refund_id

string

The unique ID of the refund provided by PSP

amount

float64

The amount of the refund transaction

currency

string

The currency of the refund transaction

refund_status

string

The status of the refund transaction

refund_type

string

The type of the refund field indicates whether a full refund or partial refund was requested

refund_reason

string

The reason for the refund

merchant_id

string

The merchant's id

description

string

The description of the refund

payment_txn_ref

string

The PortOne transaction reference of the transaction against which the refund was requested

payment_channel

string

The payment channel used to make the payment for the transaction

payment_method

string

The payment method used to make the payment for the transaction