payment-capture
This webhook will be triggered for every late capture that occurs within an order.
It is important to note that the webhook is triggered per payment capture and, in case an order has more than one payment type, an individual webhook will be triggered per payment capture.
Within the transaction payload, the operationStatus will provide if the payment capture was successful or not and the transactionID will provide the transaction key that is also better detailed on the payment payload of the webhook.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "payment-capture",
"version": "integer",
"payload": {
"id": "integer",
"basketKey": "string",
"cost": {
"tax": {
"vat": {
"amount": "integer"
}
},
"withTax": "integer",
"withoutTax": "integer",
"withTaxWithMembershipDiscountWithoutServiceCosts": "integer",
"withoutTaxWithMembershipDiscount": "integer",
"costCapture": "integer"
},
"currencyCode": "string",
"status": "string",
"detailedStatus": {
"billing": {
"code": "string",
"name": "string"
},
"order": {
"code": "string",
"name": "string"
},
"shipping": {
"code": "string",
"name": "string"
}
},
"address": {
"billing": {
"id": "integer",
"street": "string",
"houseNumber": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"isDefault": {
"billing": "boolean",
"shipping": "boolean"
},
"recipient": {
"firstName": "string",
"lastName": "string",
"gender": "string",
"type": "string"
},
"state": "string"
},
"shipping": {
"id": "integer",
"street": "string",
"houseNumber": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"isDefault": {
"billing": "boolean",
"shipping": "boolean"
},
"recipient": {
"firstName": "string",
"lastName": "string",
"gender": "string",
"type": "string"
},
"state": "string"
}
},
"contacts": [
{
"type": "string"
}
],
"items": [
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "integer",
"tax": {
"vat": {
"amount": "integer",
"rate": "integer"
}
},
"overrideWithoutTax": "integer",
"overrideWithTax": "integer",
"undiscountedWithOutTax": "integer",
"undiscountedWithTax": "integer"
},
"status": "string",
"key": "string",
"product": {
"id": "integer",
"name": "string"
},
"id": "integer",
"warehouseId": "integer",
"variant": {
"id": "integer",
"referenceKey": "string",
"stock": {
"supplierId": "integer"
}
},
"currency": "string",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "integer",
"tax": {
"vat": {
"amount": "integer",
"rate": "integer"
}
},
"overrideWithoutTax": "integer",
"overrideWithTax": "integer",
"undiscountedWithOutTax": "integer",
"undiscountedWithTax": "integer"
},
"status": "string",
"key": "string",
"product": {
"id": "integer",
"name": "string"
},
"id": "integer",
"warehouseId": "integer",
"variant": {
"id": "integer",
"referenceKey": "string",
"stock": {
"supplierId": "integer"
}
},
"currency": "string",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "integer",
"tax": {
"vat": {
"amount": "integer",
"rate": "integer"
}
},
"overrideWithoutTax": "integer",
"overrideWithTax": "integer",
"undiscountedWithOutTax": "integer",
"undiscountedWithTax": "integer"
},
"status": "string",
"key": "string",
"product": {
"id": "integer",
"name": "string"
},
"id": "integer",
"warehouseId": "integer",
"variant": {
"id": "integer",
"referenceKey": "string",
"stock": {
"supplierId": "integer"
}
},
"currency": "string",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "integer",
"tax": {
"vat": {
"amount": "integer",
"rate": "integer"
}
},
"overrideWithoutTax": "integer",
"overrideWithTax": "integer",
"undiscountedWithOutTax": "integer",
"undiscountedWithTax": "integer"
},
"status": "string",
"key": "string",
"product": {
"id": "integer",
"name": "string"
},
"id": "integer",
"warehouseId": "integer",
"variant": {
"id": "integer",
"referenceKey": "string",
"stock": {
"supplierId": "integer"
}
},
"currency": "string",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
}
],
"payment": [
{
"key": "string",
"amount": "integer",
"data": {
"success": "boolean",
"transaction_id": "string"
},
"transactionKey": "string",
"isGiftCard": "boolean"
}
],
"customer": {
"id": "integer",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"type": "string",
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
}
},
"invoicedAt": "datetime",
"packages": [
{
"id": "integer",
"carrierKey": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
},
"shipmentKey": "string",
"tracking": {
"id": "string",
"url": "string"
}
}
],
"shipping": {
"policy": "string"
},
"updatedAt": "datetime",
"createdAt": "datetime",
"confirmedAt": "datetime",
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "string",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
},
"transaction": {
"transactionId": "string",
"operationStatus": "string"
}
}
}
