Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Bundle (Beta)

Utility Remittance - Enroll into Utility Remittance

Enroll all Utility Accounts associated with the provided Utility Credential into Utility Remittance. Enrollment is an asynchronous process. Track status changes through the associated Bundle Enrollment.

post/bundle/utility_remittance/utility_credentials/{utility_credential_id}/enroll

Path parameters

utility_credential_idinteger required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

utility_account_idsnumber[] required

The list of Utility Account IDs associated with the provided Utility Credential to enroll in the Bundle product. To ensure no unintended Utility Accounts are enrolled in Bundle, we require every non-closed Utility Account associated with a Utility Credential to be explicitly provided in this parameter. We do not support Bundle for a subset of non-closed Utility Accounts associated with a Utility Credential at this time.

Example request

{
  "utility_account_ids": [
    12345,
    67890
  ]
}

Response

Success

client_user_idstring required

Your organization's unique key provided to associate Arcadia resources with your user.

utility_account_idinteger required

Unique id generated by Arcadia to identify the Utility Account associated with this resource.

product_key'hosted_payments' | 'utility_remittance' required
status'enrolled' | 'pending_enrollment' | 'ineligible' | 'pending_removal' | 'removed' nullable required
removal_reason'organization_requested' | 'dropped_cant_login' | 'dropped_payment_decline' | 'dropped_no_remittance_scheduled' | 'moved' nullable required
start_datestring date nullable required

Date the Bundle Enrollment was approved.

override_emailstring nullable required

Email address generated by Arcadia to override the user's email address on file with their Utility.

sandboxedboolean required

If true, this resource is in the sandboxed environment. If false, this resource is in the live environment.

Example response

[
  {
    "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
    "utility_account_id": 1234,
    "status": "enrolled",
    "override_email": "apb0123456@a.arcadiapower.com"
  }
]