v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB

Bundle (Beta)

Sandboxed Only, Utility Remittance - Remove active or pending removal Utility Remittance enrollment

Only available when using sandboxed API keys. Updates the Bundle Enrollments created by the enroll into Utility Remittance endpoint for each Utility Account associated with this Utility Credential. The status will change from enrolled or pending_removal to removed and trigger the utility_remittance_removed Webhook Event.

post/sandbox/bundle/utility_remittance/utility_credentials/{utility_credential_id}/remove

Path parameters

utility_credential_idinteger required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

removal_reason'organization_requested' | 'dropped_cant_login' | 'dropped_no_remittance_scheduled' required

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