Settlement webhook payload examples
Inspect the documented JSON payloads for settlement notifications.
Use samples as fixtures
These payloads reproduce the documented event examples. A sample is not a complete schema: optional fields, nulls, amounts and types may vary by event. Route using event_type, retain event_id for deduplication, and use the corresponding event_body shape. Event catalog and behavior
Gateway signature and delivery
Verify Webhook-Signature with your gateway signing key before parsing the body. This family signs nonce + a period + the original body. It is separate from Sign-Up subscriptions. Gateway webhook verification
Batch Settlement Completed
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "11750910-bd03-4f9a-871a-786203df177f", "event_type": "settlement.batch.complete", "event_body": { "batch_id": "12345678", "count": 4, "amount": "402.81", "merchant": { "id": "123456", "name": "Test Account" }, "processor": { "id": "ccprocessor", "name": "CC Processor", "type": "cc" }, "by_card_type": { "visa": { "count": 4, "amount": "402.81" } }, "transaction_ids": [ "1234000000", "1234000001", "1234000002", "1234000003" ] } } false
Batch Settlement Failed
Documented sample payload; not generated account activity. Where labeled syntax corrected, missing or trailing commas in the source have been repaired without changing field names or values. { "event_id": "dfe8156d-5dd9-43ac-8928-3cf70ef74108", "event_type": "settlement.batch.failure", "event_body": { "batch_id": "123456", "merchant": { "id": "123456", "name": "Test Merchant" }, "processor": { "id": "ccprocessor", "name": "CC Processor", "type": "cc" } } } true