Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > settle_account_balance_bulk_m

settle_account_balance_bulk_m

This API allows for the batch submission of multiple accounts to a payment processor for collection attempts on each account. 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.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
  account_info array   Array that allows for multiple account submissions for account balance settlement.
acct_no long   Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
payment_method_no long   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.
  OR      
  client_payment_method_id string   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.
  OR      
  master_plan_instance_no long   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.
  OR      
  client_master_plan_instance_id string   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.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

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

You must to post a comment.
Last modified
10:43, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.