{
"id":{VALUE},
"idempotency_key":{VALUE},
"sent_at":{VALUE},
"client":{
"id":{VALUE}
},
"events":[
{
"id":{VALUE},
"event_id":{VALUE},
"mandate_new_instruction_count":{VALUE},
"mandate_cancellation_count":{VALUE},
"mandate_convert_count":{VALUE},
"credit_total_count":{VALUE},
"credit_total_value":{VALUE},
"payment_total_count":{VALUE},
"payment_total_value":{VALUE},
"status":{VALUE},
"serial":{VALUE},
"mandate_failed_count":{VALUE},
"credit_failed_count":{VALUE},
"payment_failed_count":{VALUE},
"payment_failed_value":{VALUE},
"credit_failed_value":{VALUE},
"event_type":{VALUE},
"event_source":{VALUE},
"service_user_number":{
"id":{VALUE},
"sun_name":{VALUE},
"sun_number":{VALUE}
},
"client":{
"id":{VALUE}
},
"submission_date":{VALUE}
}
]
}
Note: Property display order for documentation purposes, actual order may vary.
Event Fields
| Property | Format | Description |
| client | object | Object containing the client information, see below |
| credit_failed_count | integer | Number of failed Credits in the Submission |
| credit_failed_value | integer | Value of failed Credits, in pence, in the Submission |
| credit_total_count | integer | Number of Credits in the Submission |
| credit_total_value | integer | |
| event_id | string | The ID of the Event |
| event_source | string | The Source that triggered the event |
| event_type | string | This will be “file_submission.create” or “file_submission.update” |
| id | string | The ID of the Record |
| mandate_cancellation_count | integer | Number of Cancelled Mandates (0C) in the Submission |
| mandate_convert_count | integer | Number of Converted Mandates (0S) in the Submission |
| mandate_failed_count | integer | Number of failed Mandates in the Submission |
| mandate_new_instruction_count | integer | Number of New Mandates (0N) in the Submission |
| payment_failed_count | integer | Number of failed Payments in the Submission |
| payment_failed_value | integer | Value of failed Payments, in pence, in the Submission |
| payment_total_count | integer | Number of Payments in the Submission |
| payment_total_value | integer | Value of Payments, in pence, in the Submission |
| serial | string | The Serial Number of the Submission |
| service_user_number | object | Object containing the service_user_number information, see below |
| status | string | The Status of the Submission, see options below |
| submission_date | ISO8601 | The date of the Submission. |
client Object Fields
| Property | Format | Description |
| id | string | ID of the record |
service_user_number Object Fields
| Property | Format | Description |
| id | string | ID of the record |
| sun_number | string | Service user number |
| sun_name | string | Friendly name for the service user number |