HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Utility Remittance Ineligible (Beta)

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 nameData typeRequired?Description
typestringyesValue: utility_remittance_ineligible
created_atstring <date-time>yesDate and time this Webhook Event was generated. Given in UTC.
dataobject (BundleEnrollment)yesData relevant to this Webhook Event.

BundleEnrollment

Property nameData typeRequired?Description
client_user_idstringyesYour organization's unique key provided to associate Arcadia resources with your user.
utility_account_idintegeryesUnique id generated by Arcadia to identify the Utility Account associated with this resource.
product_keystringyesEnum:
hosted_payments,
utility_remittance
statusnull or stringyesEnum:
enrolled,
pending_enrollment,
ineligible,
pending_removal,
removed
ineligibility_reasonsArray of objects (Ineligibility Reason)yesReasons, if any, that an Account was ineligible for Bundle. This array will always be present, but may be empty.
removal_reasonnull or stringyesEnum:
tenant_requested,
dropped_cant_login, dropped_payment_decline, dropped_no_remittance_scheduled, moved
start_datenull or string <date>yesDate the Bundle Enrollment was approved.
override_emailnull or stringyesEmail address generated by Arcadia to override the user's email address on file with their Utility.
sandboxedbooleanyesIf true, this resource is in the sandboxed environment. If false, this resource is in the live environment..

IneligibilityReason

Property nameData typeRequired?Description
resolvablebooleanyesIf true, signifies that corrective action can be taken to resolve this Ineligibility Reason. If false, this Ineligibility Reason cannot be resolved.
reasonstringyesEnum:
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

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
  }
}