refund.succeeded

A refund initiated with /refund/create succeeded

POST /api/service/webhook-event/refund.succeeded

refund.succeeded

cURL

curl --request POST \
  --url https://{yourDomain}/api/service/webhook-event/refund.succeeded \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "date": "<string>",
  "payload": {
    "id": "<string>",
    "amount": 1,
    "orderId": "<string>",
    "transactionId": "<string>"
  }
}
'

Body

application/json

Data of the webhook event

id · string · required

The unique id for the webhook.

type · enum<string> · required

Available options: refund.succeeded

date · string · required

The date of the webhook.

payload · object · required

Successful refund data with id of the refunded order.

Show child attributes

Response

200

OK