settle_account_balance_m Guide

Last updated
Save as PDF

This API is used to the collect the outstanding balance for a specific master plan instance, OR an account.

API Specification:	settle_account_balance_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id>

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error Associated Inputs: auth_key, client_id, client_no	<client_no>, <auth_key>
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>
4003: account balance is zero
4008: invalid expiration date Associated Inputs: alt_pay_method, cc_expire_mm, cc_expire_yyyy, credit_expiry_date, pay_method_type Additional Comments: Dates must be in yyyy-mm-dd format. For update_payment_method_token_m, the date must be a future date.	<cc_expire_mm>, <cc_expire_yyyy>
4009: invalid cc number Associated Inputs: cc_number, alt_pay_method, cc_num, pay_method_type	<cc_number>
4010: invalid bank draft info Associated Inputs: bank_acct_no, bank_routing_no, alt_pay_method Additional Comments: The client parameter BANK_DRAFT_INDICATOR must be enabled. Bank_acct_no and bank_routing_no are required. Valid bank_routing_no from Aria's ABA lookup in case of US address. Bank_routing_no must be numeric. For US, bank_routing_no should be 9 digits in length (left padded with zeros). Bank_routing_no must pass checksum validation.	<bank_routing_num>, <bank_acct_num>
4011: cc authorization failed Associated Inputs: alt_pay_method, cc_number, cc_expire_mm, cc_expire_yyyy, pay_method_type Additional Comments: $1 authorization has failed.	<cc_number>, <cc_expire_mm>, <cc_expire_yyyy>
4019: Invalid Bank Account Type. Associated Inputs: alt_pay_method, bank_acct_type	<bank_acct_type>
4020: Balance is less than zero
4021: Payment method or alternate payment method is required.
4044: Missing a required value. Please check that either bank_account_no, bank_routing_number or agreement_id is present.
5017: invalid iso country code Associated Inputs country, bank_country_cd, bill_country	<bill_country>, <bank_country_cd>
5054: The Account Contact name, Billing Contact name, and Statement Contact name must be the same for consumer accounts. Additional Comments: The first name, middle initial and last name of account contact, billing contact and statement contact must be the same when consumer_acct_ind = 1.	<bill_first_name>, <bill_middle_initial>, <bill_last_name>
6027: IBAN is alphanumeric and is 15 to 34 characters in length Associated Inputs: iban, alt_pay_method_iban	<iban>
6029: Bank swift code is alphanumeric and is 8 or 11 characters in length Associated Inputs: bank_swift_cd, alt_pay_method	<bank_swift_cd>
6031: BBAN is numeric and up to 16 digits Associated Inputs: alt_payment_method, bank_acct_no	<bank_acct_num>
6033: Bank branch code is numeric and up to 10 digits Associated Inputs: bank_branch_cd	<bank_branch_cd>
6034: Basic bank account number or IBAN is required for Direct Debit Associated Inputs: iban, bank_acct_no	<iban>, <bank_acct_num>
12010: Client account group does not exist Associated Inputs: collections_acct_group_no, client_acct_group_id, alt_client_acct_group_id	<alt_client_acct_group_id>
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id". Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.	<master_plan_instance_no>, <client_master_plan_instance_id>
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id". Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id	<client_master_plan_instance_id>
25020: Illegal characters entered Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.	<auth_key>, <client_acct_id>, <client_master_plan_instance_id>, <client_payment_method_id>, <cc_number>, <bank_routing_num>, <bank_acct_num>, <bill_company_name>, <bill_first_name>, <bill_middle_initial>, <bill_last_name>, <bill_address1>, <bill_address2>, <bill_city>, <bill_locality>, <bill_state_prov>, <bill_zip>, <bill_country>, <bill_email>, <bill_phone>, <bill_phone_extension>, <bill_cell_phone>, <bill_work_phone>, <bill_work_phone_extension>, <cvv>, <bank_acct_type>, <bill_drivers_license_no>, <bill_drivers_license_state>, <bill_taxpayer_id>, <bill_address3>, <alt_client_acct_group_id>, <track_data1>, <track_data2>, <soft_descriptor>, <soft_descriptor_customer_service>, <force_balance_scope>, <client_receipt_id>, <iban>, <bank_swift_cd>, <bank_country_cd>, <mandate_id>, <bank_id_cd>, <bank_branch_cd>, <fraud_control_field_name>, <fraud_control_field_value>, <proc_field_name>, <proc_field_value bank_name>, <bank_city>, <application_id>, <application_date>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value>
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	<client_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	<payment_method_no>

Additional Guidance

Input Fields

Field Name:

Notes:

<fraud_filter>

To use fraud filtering, you must have it enabled and configured in your payment gateway. Contact your payment gateway representative for setup information and additional documentation.

If you set this field to 0, then Aria will ignore all other fraud filtering fields.
If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will ignore that field.
If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.

Allowable Values

Values	Description
0	false (disable) Note: If you set this field to 0, then Aria will ignore all other fraud filtering fields.
1	true (enable) Note: If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will ignore that field.
2	Use settings specified at the collection group or payment gateway level. Note: If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.

<proc_field_override> (array)

<transaction_type>

If you use Chase Paymentech or Vantiv, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's payment information.

This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings).

The value that you pass into this field will override the Recurring Options that you set in the Aria application under:

Configuration > Payments > Payment Gateways > Chase Paymentech/Vantiv > Gateway Options; and
Configuration > Payments > Collection Groups > Chase Paymentech/Vantiv > Collection Group Options.

Currently, only Chase Paymentech and Vantiv support this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.

Aria will use this order of precedence to determine the transaction type:

value passed into this field
collection group configuration
payment gateway configuration
transaction type that you specified in the <recurring_processing_model_ind> field

Allowable Values

Values	Description
-1	Use client configuration settings for "Send Transaction Type as Recurring for Initial Request Where Possible" or "Send Transaction Type as Recurring for Subsequent Request" as applicable. (default)
1	(Chase) Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products and does not include sales that are processed via an installment plan.
2	(Chase) Recurring Transaction - Designates a transaction that represents an arrangement between an accountholder and the merchant where transactions are going to occur on a periodic basis.
3	(Chase) Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4	(Chase) Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time.
5	(Chase) Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy.)
6	(Chase) Non-Authenticated Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 3-D Secure includes Verified by Visa and Mastercard Identity Check.) Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy transactions in the event of: * A non-participating issuer * A non-participating accountholder of a participating issuer * A participating issuer, but the authentication server is not available
7	(Chase) Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), but authentication was not performed. The accountholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. For Discover, indicates an e-commerce Card Transaction with data protection in which ProtectBuy for Cardholder authentication was not used.
8	(Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where: * The transaction does not include the use of any transaction encryption such as SSL * Authentication is not performed * An accountholder certificate is not managed.
I	(Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system.
R	(Chase) Retail Transaction - Designates a transaction where the accountholder was present at a merchant location.
telephone	(Vantiv) The transaction is for a single telephone order.
mailorder	(Vantiv) The transaction is for a single mail order transaction.

<bank_acct_type>

Allowable Values

Values	Description
savings	savings
checking	checking
business	business

<force_balance_scope>

Allowable Values

Values	Description
null	Defaults to the value of client field auto_collect_account_balance_scope
C	Collect total amount currently due
F	Collect the full account balance

<fraud_filtering_enabled>

Allowable Values

Values	Description
0	disable
1	enable
-1	Use settings specified at the collection group or payment gateway level.

<change_status_on_fraud_filtering_failure>

Allowable Values

Values	Description
0	false
1	true
-1	Use settings specified at the collection group or payment gateway level.

<change_status_on_fraud_filtering_review>

Allowable Values

Values	Description
0	false
1	true
-1	Use settings specified at the collection group or payment gateway level.

<change_mp_status_on_fraud_filtering_cc_prefix_failure>

Allowable Values

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_number_failure>

Allowable Values

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_issuing_country_failure>

Allowable Values

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_issuing_country_suspect>

Allowable Values

Values	Description
0	false
1	true

<recurring_processing_model_ind>

Allowable Values

Values	Description
0	Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1	Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2	Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3	Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.