Skip to main content
Aria Knowledge Central

settle_account_balance_bulk_m Guide

This API allows for the batch submission of multiple accounts to a payment processor for collection attempts on each account. Each submitted account must be assigned to a collection group before running this API, or the collection does not take place. The supplied accounts are added to a flat file that is submitted to the payment processor. Once they make the required collection attempts, a response file is sent back to Aria and the associated accounts are updated.

API Specification: settle_account_balance_bulk_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <account_info>(array)
    • <acct_no> or <client_acct_id>
    • <payment_method_no> or <client_payment_method_id> or
    • <master_plan_instance_no> or <client_master_plan_instance_id>

Error Codes

Error Code/Description Associated Inputs

1001: unexpected error


1004: authentication error

Associated Inputs: auth_key, client_id, client_no

<auth_key>, <client_no>

1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)

Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no

<acct_no>, <client_acct_id>

1104: Your client is not configured to use this API call. Please contact Aria for more information.


4037: Two identical collection attempts were entered as part of this request. A unique collection attempt should only be requested once or collections will be made multiple times.


4038: Exceeds maximum records allowed in a bulk settle API call


14053: Invalid Master Plan Instance number

Associated Inputs: master_plan_instance_no


14054: Invalid client Master Plan Instance identifier

Associated Inputs: client_master_plan_instance_id


24381: Bulk errors

Additional Comments: This message may be returned because of an internal system error. Please contact Aria Customer Support for assistance.


26007: Provided client defined pay method ID does not exist for this account.

Associated Inputs: client_payment_method_id, client_primary_payment_method_id, client_backup_payment_method_id


26008: Provided payment_method_id does not exist for this account.

Associated Inputs: payment_method_no, payment_method_no, client_payment_method_id, primary_payment_method_no, backup_payment_method_no

  • Was this article helpful?