v5
latestOpenAPI 3.1.02026-07-262421791.5 MBBulk settlement payment received
Triggered when a bulk settlement fund is received. Once there is a match, meaning the amount for this settlement journal is fully settled, the amount_matched is set to true. If it is not matched, check the difference between source_amount and target_amount to determine how much more needs to be paid.
This event can also be triggered when our operations team reallocates funds between settlements. Therefore, the received_amount in version 2.0.0 of the webhook is inaccurate. Please use the latest version, 4.0.0. Version 2.0.0 is deprecated.
- Event type: bulk-settlement#payment-received
- Profile level subscriptions: Not Supported
- Application level subscriptions: Supported
Events may not be delivered in the order they occurred. Use data.occurred_at to reconcile the order. See the Event ordering guide for details.
See the Webhooks guide for setup instructions, signature verification, and best practices.
Headers
RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the Wise public key to ensure the request is authentic and has not been tampered with.
Unique identifier for this webhook delivery attempt.
Present with the value true if this is a test notification sent to verify your callback URL during subscription setup.
Payload
Example payload
{
"schema_version": "4.0.0",
"subscription_id": "f5b51f77-e14a-433b-9f7c-fc2834ffcff5",
"event_type": "bulk-settlement#payment-received",
"sent_at": "2024-04-18T06:36:17.123Z",
"data": {
"resource": {
"settlement_reference": "TPFB1111111",
"source_currency": "GBP",
"source_amount": -100.1,
"target_amount": 100.1,
"amount_matched": true
},
"occurred_at": "2024-04-18T06:36:15.789Z"
}
}Response
Return any 2xx status to acknowledge receipt of the event.
Example response
{
"status": "ok"
}