Webhook-Event
- POSTTest
- POSTOrder Created
- POSTOrder Updated
- POSTMerchant Updated
- POSTRefund Succeeded
- POSTRefund Failed
- POSTUser Payout Initiated
- POSTUser Payout Paid
- POSTUser Payout Failed
- POSTPayout Report Requested
- POSTData Session Completed
- POSTCheckout Session Created
- POSTCheckout Session Updated
- POSTCheckout Session Expired
- POSTCheckout Session Completed
- POSTPayout Created
- POSTPayout Updated
- POSTMandate Setup Started
- POSTMandate Setup Succeeded
- POSTMandate Setup Failed
- POSTMandate Revoked
Webhook-Event
Order Updated
An order has been updated
POST
/
api
/
service
/
webhook-event
/
order-updated
Copy
Ask AI
curl --request POST \
--url https://{yourDomain}/api/service/webhook-event/order-updated \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"type": "order_updated",
"date": "<string>",
"payload": {
"id": "<string>",
"merchantId": "<string>",
"payerFinancialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
}
},
"appId": "<string>",
"merchantAppId": "<string>",
"shopName": "<string>",
"referenceId": "<string>",
"displayId": "<string>",
"offsetProject": "<string>",
"metadata": {},
"category": "<string>",
"co2Grams": 1,
"applicationFeeAmount": 1,
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"lineItems": [
{
"name": "<string>",
"referenceId": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"shopLogo": "<string>",
"guest": false,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"impactOffsetProjects": [
"<any>"
],
"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"
},
"paymentStatus": "not_settled",
"status": "failed",
"refunds": [
{
"id": "<string>",
"description": "<string>",
"referenceId": "<string>",
"amount": 1,
"status": "pending",
"createdAt": "<any>",
"updatedAt": "<any>"
}
],
"refundAmount": 1,
"createdAt": "<any>",
"updatedAt": "<any>",
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"trees": 123,
"merchantFinancialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>",
"destination": {
"bankAccount": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>"
},
"paymentMethodType": "sepa_debit",
"setupPaymentMandate": true,
"statusHistoryList": [
{
"previousStatus": "failed",
"currentStatus": "failed",
"reason": "ORDER_CREATED",
"createdAt": "<any>",
"updatedAt": "<any>"
}
],
"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>",
"subaccountLegalName": "<string>",
"instantPaymentScheme": true,
"statusClassification": {
"primary": "payment_authorisation_failed",
"secondary": "timeout"
},
"paymentMode": "direct",
"customerId": "<string>",
"bankId": "<string>"
}
}'
Body
application/json
Data of the webhook event
The body is of type object
.
Response
200
OK
Copy
Ask AI
curl --request POST \
--url https://{yourDomain}/api/service/webhook-event/order-updated \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"type": "order_updated",
"date": "<string>",
"payload": {
"id": "<string>",
"merchantId": "<string>",
"payerFinancialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
}
},
"appId": "<string>",
"merchantAppId": "<string>",
"shopName": "<string>",
"referenceId": "<string>",
"displayId": "<string>",
"offsetProject": "<string>",
"metadata": {},
"category": "<string>",
"co2Grams": 1,
"applicationFeeAmount": 1,
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"lineItems": [
{
"name": "<string>",
"referenceId": "<string>",
"singleNet": 123,
"singleVat": 123,
"amount": 123,
"quantity": 1,
"image": "<string>",
"category": "5045",
"EAN": "<string>",
"co2Grams": 1
}
],
"shopLogo": "<string>",
"guest": false,
"climateActionMode": {
"type": "transaction",
"amount": 123
},
"impactOffsetProjects": [
"<any>"
],
"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"
},
"paymentStatus": "not_settled",
"status": "failed",
"refunds": [
{
"id": "<string>",
"description": "<string>",
"referenceId": "<string>",
"amount": 1,
"status": "pending",
"createdAt": "<any>",
"updatedAt": "<any>"
}
],
"refundAmount": 1,
"createdAt": "<any>",
"updatedAt": "<any>",
"shopperEmail": "<string>",
"shopper": {
"email": "<string>",
"phoneNumber": "<string>"
},
"trees": 123,
"merchantFinancialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>",
"destination": {
"bankAccount": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"paymentReference": "<string>"
},
"bankStatementReference": "<string>"
},
"paymentMethodType": "sepa_debit",
"setupPaymentMandate": true,
"statusHistoryList": [
{
"previousStatus": "failed",
"currentStatus": "failed",
"reason": "ORDER_CREATED",
"createdAt": "<any>",
"updatedAt": "<any>"
}
],
"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>",
"subaccountLegalName": "<string>",
"instantPaymentScheme": true,
"statusClassification": {
"primary": "payment_authorisation_failed",
"secondary": "timeout"
},
"paymentMode": "direct",
"customerId": "<string>",
"bankId": "<string>"
}
}'
Assistant
Responses are generated using AI and may contain mistakes.