{
"allocation": {
"slug": "NqqplzPl",
"link": "https://api.au.cr4ce.com/allocation/NqqplzPl"
},
"allocation_amount": 500,
"amount": 280.65,
"comments": "",
"created": "2024-03-19T14:00:25Z",
"currency": "GBP",
"date_due": null,
"date_paid": null,
"applicant": {
"slug": "AbCdEfGh",
"link": "https://api.au.cr4ce.com/user/AbCdEfGh",
"name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"global_id": "9c78dcbc-53cf-42f1-b5b3-82fe396f66e6"
},
"application": {
"slug": "PqRsTuVw",
"id": 4821,
"title": "Project title",
"link": "https://api.au.cr4ce.com/application/PqRsTuVw"
},
"external_id": "",
"fund": {
"slug": "PVzOmlXO",
"link": "https://api.au.cr4ce.com/fund/PVzOmlXO",
"name": {
"en_GB": "Maintenance"
}
},
"grant_status": null,
"payment_method": null,
"reference": "",
"season": {
"slug": "wboyrBmo",
"link": "https://api.au.cr4ce.com/season/wboyrBmo",
"name": {
"en_GB": "2026"
}
},
"slug": "oQKEeNDy",
"status": "Scheduled",
"updated": "2024-03-19T14:00:35Z",
"event": "Allocation payment created",
"timestamp": "2026-08-14T09:30:00Z",
"trigger": "allocation_payment_created",
"source": "api"
}Allocation payment updated
{
"allocation": {
"slug": "NqqplzPl",
"link": "https://api.au.cr4ce.com/allocation/NqqplzPl"
},
"allocation_amount": 500,
"amount": 280.65,
"comments": "",
"created": "2024-03-19T14:00:25Z",
"currency": "GBP",
"date_due": null,
"date_paid": null,
"applicant": {
"slug": "AbCdEfGh",
"link": "https://api.au.cr4ce.com/user/AbCdEfGh",
"name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"global_id": "9c78dcbc-53cf-42f1-b5b3-82fe396f66e6"
},
"application": {
"slug": "PqRsTuVw",
"id": 4821,
"title": "Project title",
"link": "https://api.au.cr4ce.com/application/PqRsTuVw"
},
"external_id": "",
"fund": {
"slug": "PVzOmlXO",
"link": "https://api.au.cr4ce.com/fund/PVzOmlXO",
"name": {
"en_GB": "Maintenance"
}
},
"grant_status": null,
"payment_method": null,
"reference": "",
"season": {
"slug": "wboyrBmo",
"link": "https://api.au.cr4ce.com/season/wboyrBmo",
"name": {
"en_GB": "2026"
}
},
"slug": "oQKEeNDy",
"status": "Scheduled",
"updated": "2024-03-19T14:00:35Z",
"event": "Allocation payment created",
"timestamp": "2026-08-14T09:30:00Z",
"trigger": "allocation_payment_created",
"source": "api"
}Headers
HMAC SHA256 signature of the request body. Generated using the webhook's signing key and the raw JSON payload.
Generate the same value in your endpoint and compare it with this header to validate the webhook payload.
"a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890"
Body
Payload delivered for allocation payment-related events.
Scheduled or recorded disbursement of funds against an allocation.
Allocation the payment is drawn against.
Show child attributes
Show child attributes
Amount of the payment, in the fund's currency.
Comment log attached to the payment, formatted as newline-joined author (timestamp): body entries, empty when there are none.
Date and time when the payment was created.
ISO 4217 currency code of the payment's amounts, drawn from the fund's currency.
Date and time when the payment is due, null if not set.
Date and time when the payment was made, null if not yet paid.
External identifier of the payment, used to reconcile with downstream systems, empty when none is set.
Grant status of the application, null when there is none.
Show child attributes
Show child attributes
Payment method recorded against the payment, null when none is set.
Show child attributes
Show child attributes
Free-text reference for the payment, empty when none is set.
Season the payment belongs to.
Show child attributes
Show child attributes
URL-safe identifier of the payment.
Lifecycle status of the payment, returned as a localised label such as Scheduled, Processing, Paid, Failed, or Failed permanently.
Date and time when the payment was last updated.
Total amount of the allocation the payment is drawn against, in the fund's currency.
Applicant who owns the application, null when there is none.
Show child attributes
Show child attributes
Application the allocation belongs to, null when there is none.
Show child attributes
Show child attributes
Fund the allocation draws from.
Show child attributes
Show child attributes
Human-readable name of the event that triggered the webhook.
"Allocation payment created"
ISO 8601 formatted datetime indicating when the event occurred.
"2020-01-01T00:00:00Z"
Machine-readable event key that fired the webhook.
"allocation_payment_created"
Origin of the change that triggered the event.
ui, api Response
Return any 2xx status code to acknowledge receipt of the event.