Allocation payment created
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. Combines the allocation payment
data with the common webhook envelope fields (event, timestamp, trigger, source).
Scheduled or recorded disbursement of funds against an allocation, the application-level grant slot drawn from a fund's budget.
Carries the payment amount and currency, its lifecycle status, the due and paid dates, and references to the related allocation, fund, season, payment method, and grant status.
Allocation the payment is drawn against.
Amount of the payment, in the fund's currency.
Comment log attached to the payment, rendered as a newline-joined export string of author (timestamp): body items. Empty string when the payment has no comments.
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 when no due date is set.
Date and time when the payment was made. null when the payment has not been made.
External identifier of the payment, used to reconcile it with downstream systems. Empty string when none is set.
Grant status of the application the allocation belongs to.
null when the application has no grant status.
Payment method recorded against the payment.
null when no payment method is set.
Free-text reference for the payment. Empty string when none is set.
Season the payment belongs to.
URL-safe identifier of the payment.
Lifecycle status of the payment, returned as a localised label rendered in the account's language.
Typical English labels are Scheduled, Processing, Paid, Failed, and 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 the allocation belongs to.
null when the application has no applicant.
Application the allocation belongs to.
null when the payment has no associated application.
Fund the allocation draws from.
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.