Webhook-Event
Refund Failed
Webhook
Webhook-Subscription
Webhook-Event
Refund Failed
A refund initiated with /merchant/payment/refund
failed
POST
/
webhook-event
/
refund-failed
curl --request POST \
--url https://{yourDomain}/webhook-event/refund-failed \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"type": "test",
"date": "<string>",
"payload": {
"id": "<string>",
"payerFinancialAddress": {
"type": "<string>",
"iban": {
"iban": "<string>",
"bic": "<string>",
"accountHolderName": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
}
},
"merchantId": "<string>",
"appId": "<string>",
"merchantAppId": "<string>",
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"shopName": "<string>",
"billingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"shippingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"referenceId": "<string>",
"metadata": {},
"category": "<string>",
"applicationFeeAmount": 123,
"price": {
"total": 123,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"co2Grams": 123,
"trees": 123,
"lineItems": [
{
"name": "<string>",
"referenceId": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"quantity": 123,
"image": "<string>",
"category": "<string>",
"EAN": "<string>"
}
],
"shopLogo": "<string>",
"incentiveMode": "white_label",
"guest": true,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"impactOffsetProjects": [
"<string>"
],
"shippingMethod": {
"id": "<string>",
"price": 123,
"name": "<string>",
"countries": [
"AF"
],
"reference": "<string>",
"timeFrame": "<string>",
"deliveryEstimate": {
"minimum": {
"unit": "hour",
"value": 123
},
"maximum": {
"unit": "hour",
"value": 123
}
}
},
"paymentStatus": "failed",
"status": "failed",
"refunds": [
{
"id": "<string>",
"description": "<string>",
"referenceId": "<string>",
"amount": 123,
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"refundAmount": 123,
"offsetProject": "<string>",
"displayId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"merchantFinancialAddress": {
"type": "<string>",
"iban": {
"iban": "<string>",
"bic": "<string>",
"accountHolderName": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>",
"destination": {
"bankAccount": {
"type": "<string>",
"iban": {
"iban": "<string>",
"bic": "<string>",
"accountHolderName": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
}
},
"bankStatementReference": "<string>"
},
"statusHistoryList": [
{
"previousStatus": "failed",
"currentStatus": "failed",
"reason": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"paymentMethodType": "sepa_debit",
"mandate": {
"setup": false,
"referenceId": "<string>",
"accountHolderName": "<string>",
"userNotificationEmail": "<string>",
"additionalDisplayInformation": {
"price": {
"amount": 123,
"currency": "EUR"
},
"cadence": "BI_WEEKLY"
},
"reference": "<string>",
"creditor": {
"name": "<string>",
"id": "<string>"
}
},
"subaccountId": "<string>",
"instantPaymentScheme": true,
"statusClassification": {
"primary": "<string>",
"secondary": "<string>"
},
"subaccountLegalName": "<string>",
"paymentMode": "settlement",
"customerId": "<string>",
"bankId": "<string>"
}
}'
Body
application/json
Data of the webhook event
The body is of type object
.
Response
200
OK
curl --request POST \
--url https://{yourDomain}/webhook-event/refund-failed \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"type": "test",
"date": "<string>",
"payload": {
"id": "<string>",
"payerFinancialAddress": {
"type": "<string>",
"iban": {
"iban": "<string>",
"bic": "<string>",
"accountHolderName": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
}
},
"merchantId": "<string>",
"appId": "<string>",
"merchantAppId": "<string>",
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"shopName": "<string>",
"billingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"shippingAddress": {
"firstName": "<string>",
"lastName": "<string>",
"line1": "<string>",
"line2": "<string>",
"region": "<string>",
"city": "<string>",
"zipCode": "<string>",
"country": "AF"
},
"referenceId": "<string>",
"metadata": {},
"category": "<string>",
"applicationFeeAmount": 123,
"price": {
"total": 123,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"co2Grams": 123,
"trees": 123,
"lineItems": [
{
"name": "<string>",
"referenceId": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"quantity": 123,
"image": "<string>",
"category": "<string>",
"EAN": "<string>"
}
],
"shopLogo": "<string>",
"incentiveMode": "white_label",
"guest": true,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"impactOffsetProjects": [
"<string>"
],
"shippingMethod": {
"id": "<string>",
"price": 123,
"name": "<string>",
"countries": [
"AF"
],
"reference": "<string>",
"timeFrame": "<string>",
"deliveryEstimate": {
"minimum": {
"unit": "hour",
"value": 123
},
"maximum": {
"unit": "hour",
"value": 123
}
}
},
"paymentStatus": "failed",
"status": "failed",
"refunds": [
{
"id": "<string>",
"description": "<string>",
"referenceId": "<string>",
"amount": 123,
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"refundAmount": 123,
"offsetProject": "<string>",
"displayId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"merchantFinancialAddress": {
"type": "<string>",
"iban": {
"iban": "<string>",
"bic": "<string>",
"accountHolderName": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>",
"destination": {
"bankAccount": {
"type": "<string>",
"iban": {
"iban": "<string>",
"bic": "<string>",
"accountHolderName": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
}
},
"bankStatementReference": "<string>"
},
"statusHistoryList": [
{
"previousStatus": "failed",
"currentStatus": "failed",
"reason": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"paymentMethodType": "sepa_debit",
"mandate": {
"setup": false,
"referenceId": "<string>",
"accountHolderName": "<string>",
"userNotificationEmail": "<string>",
"additionalDisplayInformation": {
"price": {
"amount": 123,
"currency": "EUR"
},
"cadence": "BI_WEEKLY"
},
"reference": "<string>",
"creditor": {
"name": "<string>",
"id": "<string>"
}
},
"subaccountId": "<string>",
"instantPaymentScheme": true,
"statusClassification": {
"primary": "<string>",
"secondary": "<string>"
},
"subaccountLegalName": "<string>",
"paymentMode": "settlement",
"customerId": "<string>",
"bankId": "<string>"
}
}'