{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_version": "v1",
"event": "payment.failed",
"category": "payment_lifecycle",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": {
"amount": 123,
"currency": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"payment_method": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"chain": "<string>"
},
"capture_method": "<string>",
"fraud_check": {
"provider": "<string>",
"config": {
"threshold": "<string>",
"sequence": "<string>"
}
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"destination": {
"amount": 123,
"currency": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"payment_method": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"chain": "<string>"
}
},
"fee": {
"bearer": "<string>",
"amount": 123,
"currency": "<string>"
},
"reference_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_installments": 123,
"installments": [
{
"number": 123,
"amount": 123,
"status": "<string>",
"settlement_date": "2023-11-07T05:31:56Z"
}
],
"settlement_date": "2023-11-07T05:31:56Z",
"metadata": {},
"provider_response": {}
}
}Payment failed
Payment failed. Emitted when a payment transitions to the payment.failed
state in its lifecycle. Payload is the full WebhookTransactionData for the
payment. Retries preserve data.id; deduplicate on
CrowdSplit-Notification-Id.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_version": "v1",
"event": "payment.failed",
"category": "payment_lifecycle",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": {
"amount": 123,
"currency": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"payment_method": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"chain": "<string>"
},
"capture_method": "<string>",
"fraud_check": {
"provider": "<string>",
"config": {
"threshold": "<string>",
"sequence": "<string>"
}
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"destination": {
"amount": 123,
"currency": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"payment_method": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"chain": "<string>"
}
},
"fee": {
"bearer": "<string>",
"amount": 123,
"currency": "<string>"
},
"reference_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_installments": 123,
"installments": [
{
"number": 123,
"amount": 123,
"status": "<string>",
"settlement_date": "2023-11-07T05:31:56Z"
}
],
"settlement_date": "2023-11-07T05:31:56Z",
"metadata": {},
"provider_response": {}
}
}Authorizations
Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer
Headers
HMAC-SHA256 signature over the raw request body, signed with the
merchant's webhook secret. Format: t={unix-ts},v1={hex-hmac}.
"t=1713456789,v1=a1b2c3d4e5f6abcdef1234567890abcdef1234567890abcdef1234567890abcd"
Unix timestamp (seconds since epoch) at dispatch. Merchants should reject the delivery if the skew against their own clock exceeds 5 minutes, to limit replay windows.
1713456789
Unique delivery ID. Stable across retries of the same logical event — use it to deduplicate idempotently on receipt.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Body
Base envelope delivered to merchant webhook endpoints. Every webhook
request body has the shape { id, api_version, event, category, data };
concrete event schemas compose this base via allOf and refine event /
category to their const values and data to a specific schema.
Each delivery carries three headers:
CrowdSplit-Signature t={unix-ts},v1={hex-hmac-sha256}
CrowdSplit-Timestamp seconds since epoch
CrowdSplit-Notification-Id unique per delivery (idempotency)
Merchants MUST verify the HMAC of the raw body using the webhook
secret returned at registration, and SHOULD reject the delivery if
CrowdSplit-Timestamp differs from the current time by more than
5 minutes. Duplicate CrowdSplit-Notification-Id values indicate a
retry of a previously dispatched delivery and should be deduplicated.
Unique notification ID (stable across retry attempts).
API version of the payload builder that produced this event
(currently always v1). Reports the version of the code that built
data — not a globally-bumped number — so when one event type later
moves to v2, only that event reports v2. Branch on this field if
you need to handle multiple payload shapes for the same event.
^v[0-9]+$"v1"
Event name; specialized via allOf per operation (e.g. payment.succeeded).
"payment.failed"Event category; specialized via allOf per operation (e.g. payment_lifecycle).
"payment_lifecycle"Data payload for payment, refund, transfer, buy, sell, payout, and external events
Show child attributes
Show child attributes
Response
Webhook acknowledged