curl --request POST \
--url https://{yourDomain}/api/service/webhook-event/refund_succeeded \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "refund_succeeded",
"date": "<string>",
"payload": {
"id": "<string>",
"merchantId": "<string>",
"appId": "<string>",
"merchantAppId": "<string>",
"shopName": "<string>",
"referenceId": "<string>",
"applicationFeeAmount": 1,
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"status": "failed",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"instantPaymentScheme": true,
"displayId": "<string>",
"offsetProject": "<string>",
"metadata": {},
"category": "<string>",
"co2Grams": 1,
"lineItems": [
{
"name": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"referenceId": "<string>",
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"shopLogo": "<string>",
"guest": false,
"impactOffsetProjects": [
"<unknown>"
],
"paymentStatus": "not_settled",
"refunds": [
{
"id": "<string>",
"referenceId": "<string>",
"amount": 1,
"status": "pending",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"description": "<string>",
"transactionId": "<string>"
}
],
"refundAmount": 1,
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"trees": 123,
"bankStatementReference": "<string>",
"paymentMethodType": "customer_balance",
"statusHistoryList": [
{
"currentStatus": "failed",
"reason": "ORDER_CREATED",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"previousStatus": "failed"
}
],
"subaccountId": "<string>",
"subaccountLegalName": "<string>",
"paymentMode": "direct",
"customerId": "<string>",
"bankId": "<string>",
"transactionId": "<string>"
}
}
'A refund initiated with /merchant/payment/refund succeeded
curl --request POST \
--url https://{yourDomain}/api/service/webhook-event/refund_succeeded \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "refund_succeeded",
"date": "<string>",
"payload": {
"id": "<string>",
"merchantId": "<string>",
"appId": "<string>",
"merchantAppId": "<string>",
"shopName": "<string>",
"referenceId": "<string>",
"applicationFeeAmount": 1,
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"status": "failed",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"instantPaymentScheme": true,
"displayId": "<string>",
"offsetProject": "<string>",
"metadata": {},
"category": "<string>",
"co2Grams": 1,
"lineItems": [
{
"name": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"referenceId": "<string>",
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"shopLogo": "<string>",
"guest": false,
"impactOffsetProjects": [
"<unknown>"
],
"paymentStatus": "not_settled",
"refunds": [
{
"id": "<string>",
"referenceId": "<string>",
"amount": 1,
"status": "pending",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"description": "<string>",
"transactionId": "<string>"
}
],
"refundAmount": 1,
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"trees": 123,
"bankStatementReference": "<string>",
"paymentMethodType": "customer_balance",
"statusHistoryList": [
{
"currentStatus": "failed",
"reason": "ORDER_CREATED",
"createdAt": "<unknown>",
"updatedAt": "<unknown>",
"previousStatus": "failed"
}
],
"subaccountId": "<string>",
"subaccountLegalName": "<string>",
"paymentMode": "direct",
"customerId": "<string>",
"bankId": "<string>",
"transactionId": "<string>"
}
}
'Data of the webhook event
OK
Was this page helpful?