Webhook Event posted when a Utility Remittance Bundle Enrollment request has been marked as ineligible. In some cases, ineligibility can be resolved with corrective action. Once ineligibility is resolved, a new Bundle Enrollment request can be submitted.
Request Body Schema
Property name | Data type | Required? | Description |
---|---|---|---|
type | string | yes | Value: utility_remittance_ineligible |
created_at | string <date-time> | yes | Date and time this Webhook Event was generated. Given in UTC. |
data | object (BundleEnrollment) | yes | Data relevant to this Webhook Event. |
BundleEnrollment
Property name | Data type | Required? | Description |
---|---|---|---|
| string | yes | Your organization's unique key provided to associate Arcadia resources with your user. |
| integer | yes | Unique |
| string | yes | Enum: |
| null or string | yes | Enum: |
| Array of objects (Ineligibility Reason) | yes | Reasons, if any, that an Account was ineligible for Bundle. This array will always be present, but may be empty. |
| null or string | yes | Enum: |
| null or string <date> | yes | Date the Bundle Enrollment was approved. |
| null or string | yes | Email address generated by Arcadia to override the user's email address on file with their Utility. |
| boolean | yes | If |
IneligibilityReason
Property name | Data type | Required? | Description |
---|---|---|---|
| boolean | yes | If |
| string | yes | Enum: |
Request sample
Content type: application/json
{
"type": "utility_remittance_ineligible",
"created_at": "2022-08-24T14:15:22Z",
"data": {
"client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
"utility_account_id": 1234,
"product_key": "utility_remittance",
"status": "ineligible",
"ineligibility_reasons": [
{
"resolvable": false,
"reason": "2fa"
}
],
"removal_reason": null,
"start_date": null,
"override_email": null,
"sandboxed": false
}
}