Pay File Created (payFileCreated)
Sent when a file payment consent has been created.
Id: payFileCreated
Event that notifies when a file payment consent has been created.
Payload
These fields are sent in the payload object of the webhook envelope.
| Name | Type | Description |
|---|---|---|
| payFileRequestId | string | The id of the pay file request |
| authorizationRequestId | string | The id of the authorisation request |
| status | string | The file payment consent status. Authorised means the consent has been authorised |
| submittedAt | string | The time the pay file consent was submitted (UTC, ISO 8601) |
Example (JSON format)
{
"id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
"eventType": "payFileCreated",
"userId": "5c79210bbac25ecb5e71ac40",
"payload": {
"payFileRequestId": "3c2b1a09-7e6d-4c5b-8a19-0f1e2d3c4b5a",
"authorizationRequestId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"status": "Authorised",
"submittedAt": "2024-03-20T10:00:00Z"
}
}This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.
Related
Updated about 6 hours ago