Summary

API Name	settle_account_balance_bulk_m
Class	transaction_services_m
Update Version	6.51

Description

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.

Inputs

Name	Type	Length	Required	Description
client_no	long	22	Yes	Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key	string	32	No	Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
account_info	object		No	Array that allows for multiple account submissions for account balance settlement. See fields below

Name

Type

Length

Required

Description

client_no

long

22

Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

32

No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.

account_info

object

No

Array that allows for multiple account submissions for account balance settlement.

See fields below

account_info fields

Name	Type	Length	Required	Description
acct_no	long		Yes	Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Accounts must be assigned to a collection group before running this API, or the collection does not take place. Alternative required field: client_acct_id
client_acct_id	string	50	Yes	Client-defined account identifier. Alternative required field: acct_no
payment_method_no	long	22	Yes	Aria-assigned sequence number for this payment method. Either payment method or MPI information must be provided. If both are provided the payment method will be used to collect the amount due for the MPI specified. Alternative required field: client_payment_method_id, master_plan_instance_no, or client_master_plan_instance_id
client_payment_method_id	string		Yes	Client-defined identifier for this payment method. Either payment method or MPI information must be provided. If both are provided the payment method will be used to collect the amount due for the MPI specified. Alternative required field: payment_method_no, master_plan_instance_no, or client_master_plan_instance_id
master_plan_instance_no	long	22	Yes	Aria-generated unique identifier for the master plan instance. Either payment method or MPI information must be provided. If both are provided the payment method will be used to collect the amount due for the MPI specified. Alternative required field: payment_method_no, client_payment_method_id, or client_master_plan_instance_id
client_master_plan_instance_id	string	100	Yes	Client-defined unique identifier for the master plan instance. Either payment method or MPI information must be provided. If both are provided the payment method will be used to collect the amount due for the MPI specified. Alternative required field: payment_method_no, client_payment_method_id, or master_plan_instance_no

Outputs

Name	Type	Length	Required	Description
error_code	long		No	Aria-assigned error identifier. 0 indicates no error.
error_msg	string		No	Description of any error that occurred. "Batch successfully submitted" if there was no error.