Property name | Data type | Required? | Description |
---|
type | string | yes | Value: utility_remittance_pending_enrollment |
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. |
Property name | Data type | Required? | Description |
---|
client_user_id | string | yes | Your organization's unique key provided to associate Arc resources with your user. |
utility_account_id | integer | yes | Unique id generated by Arc to identify the Utility Account associated with this resource. |
product_key | string | yes | Enum:
hosted_payments ,
utility_remittance |
status | null or string | yes | Enum:
enrolled ,
pending_enrollment ,
ineligible ,
pending_removal ,
removed |
ineligibility_reasons | 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. |
removal_reason | null or string | yes | Enum:
tenant_requested ,
dropped_cant_login , dropped_payment_decline , dropped_no_remittance_scheduled , moved |
start_date | null or string <date> | yes | Date the Bundle Enrollment was approved. |
override_email | null or string | yes | Email address generated by Arc to override the user's email address on file with their Utility. |
sandboxed | boolean | yes | If true , this resource is in the sandboxed environment. If false , this resource is in the live environment. |
Property name | Data type | Required? | Description |
---|
resolvable | boolean | yes | If true , signifies that corrective action can be taken to resolve this Ineligibility Reason. If false , this Ineligibility Reason cannot be resolved. |
reason | string | yes | Enum:
2fa ,
ebill_ineligible_incorrect_credentials ,
ebill_ineligible_third_party ,
gas_only ,
inactive_utility_account ,
incomplete_utility_account ,
missing_payment_method ,
past_due ,
payment_arrangement ,
sdg&e_paperless_gas_account ,
sibling_account_ineligible ,
solar_non_approved_utility |
Content type: application/json
{
"type": "utility_remittance_pending_enrollment",
"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": "pending_enrollment",
"ineligibility_reasons": [],
"removal_reason": null,
"start_date": null,
"override_email": null,
"sandboxed": false
}
}