Skip to main content
Aria Knowledge Central

settle_account_balance_m

  1. Last updated
  2. Save as PDF

Summary

API Name settle_account_balance_m
Class transaction_services_m
Update Version 56

Description

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

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.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
master_plan_instance_no long 22 No

Aria generated unique identifier for the master plan instance.

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined unique identifier for the master plan instance.

Alternative field: master_plan_instance_no
payment_method_no long 22 No

Aria-assigned sequence number for this payment method.The payment_method_no, OR client_payment_method_id, OR alt_pay_method is REQUIRED, if the master_plan_instance_no AND client_master_plan_instance_id is NULL.
client_payment_method_id string 32 No

Client-defined sequence number for this payment method. The payment_method_no, OR client_payment_method_id, OR alt_pay_method is REQUIRED, if the master_plan_instance_no AND client_master_plan_instance_id is NULL.
alt_pay_method long 2 No

If you want to use the account's current form of payment, leave this field NULL. If you want to use an alternate card, enter '1' in this field. The payment_method_no, OR client_payment_method_id, OR alt_pay_method is REQUIRED, if the master_plan_instance_no AND client_master_plan_instance_id is NULL.
cc_number string 24 No

Credit card number.
cc_expire_mm long 2 No

Expiration month for the credit card payment instrument.
cc_expire_yyyy long 4 No

Expiration year for the credit card payment instrument.
bank_routing_num string 22 No

The American Banking Association (ABA) routing number for the financial institution.
bank_acct_num string 32 No

The bank account number.
bill_company_name string 100 No

Company name of the billing contact.
bill_first_name string 32 No

First name of the billing contact.
bill_middle_initial string 2 No

Middle initial of the billing contact.
bill_last_name string 32 No

Last name of the billing contact.
bill_address1 string 100 No

First address line of the billing contact.
bill_address2 string 100 No

Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
bill_city string 32 No

City of the billing contact.
bill_locality string 32 No

Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
bill_state_prov string 10 No

State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
bill_zip string 16 No

Zip Code of the billing contact
bill_country string 3 No

Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bill_email string 320 No

Email of the billing contact.
bill_phone string 25 No

Phone number of the billing contact.
bill_phone_extension string 20 No

Phone extension of the billing contact.
bill_cell_phone string 20 No

Cell phone number of the billing contact.
bill_work_phone string 25 No

Work phone number of the billing contact.
bill_work_phone_extension string 20 No

Work phone extenstion of the billing contact
cvv string 6 No

Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
bank_acct_type string 32 No

The type of bank account being used.

Allowed values:

Value Description
savings  
checking  
business  
bill_drivers_license_no string 32 No

Drivers license number of the billing contact
bill_drivers_license_state string 2 No

Drivers license state of the billing contact. The official postal-service codes for all United States and Canada states, provinces, and territories.
bill_taxpayer_id string 32 No

Taxpayer ID of the billing contact
bill_address3 string 100 No

The third line of the billing address.
alt_client_acct_group_id string 100 No

One-time collections account group to use for this specific call. Default collections group on the account is not changed.
track_data1 string 300 No

Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
track_data2 string 300 No

Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
soft_descriptor string   No

Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field will be ignored if not supported/certified by the payment processor.
soft_descriptor_customer_service string   No

Transaction description shown on the buyer's statement that displays a City for Card Present transactions or a Phone Number for Card Not Present transactions. This field will be ignored if not supported/certified by the payment processor.
force_balance_scope string 1 No

Determines what constitutes the account collectible balance for this transaction

Allowed values:

Value 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
client_receipt_id string 50 No

Client-defined unique identifier used to track related system actions.
iban string 50 No

International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
bank_check_digit long 2 No

Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
bank_swift_cd string 15 No

SWIFT code is a standard format of Bank Identifier Codes (BIC). It is used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
bank_country_cd string 2 No

Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
mandate_id string 35 No

Used for the Direct Debit payment method. A mandate is signed by the debtor to authorize the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
bank_id_cd string 10 No

Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
bank_branch_cd string 10 No

Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank branch code.
fraud_filter long 1 No

Enable Fraud Filtering. This is supported if your payment processor supports this feature and has been certified with Aria. If no values are provided, the system will default to 2.

Allowed values:

Value Description
0 False. Fraud Filtering and status update will not be performed on the transaction.
1 True. Fraud Filtering and status update on the transaction will be performed based on the API supplied fraud_control_fields. Collection group level or Payment Gateway level fraud control parameters will not be considered for the status update.
2 True. Fraud Filtering and status update on the transaction will be performed based on the API input and Collection Group/Payment Gateway level parameters. fraud_control_fields will be merged with API Inputs and Collection Group/Payment Gateway level values with the precedence of API inputs.
fraud_control_fields object   No

List of key-value pair parameters to control Fraud Control.

See fields below

Allowed values:

Value Description
fraud_filtering_enabled This is a feature that some payment processors provide that will return fraud filtering results. Aria must be certified with that specific payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If False(0) is set, all other fraud_filtering_xxx features are ignored. If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (Use Payment Gateway Setting or Enabled or Disabled) will be used.
change_status_on_fraud_filtering_failure This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_filtering_failure if set to 1 (True) and the fraud_filtering_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_filtering_failure This should only be set if change_status_on_fraud_filtering_failure is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_status_on_fraud_filtering_review This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_filtering_review if set to 1 (True) and the fraud_filtering_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_filtering_review This should only be set if change_status_on_fraud_filtering_review is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_prefix_failure This is a flag that indicates that the master plan instance status should be changed if the CC Prefix Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_prefix_failure This should only be set if change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_number_failure This is a flag that indicates that the master plan instance status should be changed if the CC Number Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_number_failure This should only be set if change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_issuing_country_failure This is a flag that indicates that the master plan instance status should be changed if the CC Issuing Country Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_issuing_country_failure This should only be set if change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_issuing_country_suspect This is a flag that indicates that the master plan instance status should be changed if the CC Issuing Country Fraud Filtering check as part of the Direct Post process returned a "suspect" value. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_issuing_country_suspect This should only be set if change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
fraud_scoring_enabled This is a feature that some payment processors provide that will return a fraud score. Aria must be certified with that specific payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If False(0) is set, all other fraud_scoring_xxx features are ignored. If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (Use Payment Gateway Setting or Enabled or Disabled) will be used.
change_status_on_fraud_scoring_failure This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_scoring_failure if set to 1 (True) and the fraud_scoring_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_scoring_failure This should only be set if change_status_on_fraud_scoring_failure is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_status_on_fraud_scoring_review This is a flag that indicates that the master plan instance status should be changed if a fraud scoring enabled was performed and "review" was returned as part of the fraud score result. Set it to 1 (True) if changing the master plan instance status is desired. The allowed values are 1 (True), 0 (False) and -1 (Use Collection Group/Payment Gateway Setting). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_scoring_review This should only be set if change_status_on_fraud_scoring_review is set to 1 (True). This must be a valid Aria master plan instance status code. Aria master plan instance status codes can be found in the API documentation.
fraud_scoring_threshold This is a feature that some payment processors provide that will return a fraud score as a numeric value. Aria must be certified with that particular payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If the payment processor returns non-numeric fraud score responses, Aria will ignore this threshold. As of now it is not supported for Vantiv processor.
recurring_processing_model_ind long 1 No

Defines a recurring payment type for Credit Card and Tokenized Credit Cards. A null value will default to 0 - Cardholder-Initiated Transaction - Credentials on File.

Allowed values:

Value 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.
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.
proc_field_override array   No

The processor-specific fields passed as an array of proc_field_name/proc_field_value key-value pairs. The allowable fields and values for the key-value pairs are highlighted in blue below.

See allowable proc_field_names
bank_name string 100 No

Bank name for the account payment method
bank_city string 100 No

Bank city for the account payment method
bank_acct_holder_type string 32 No

This field denotes the bank account holder type. The value can be either individual or company.

Allowed values:

Value Description
individual  
company  
mandate_signature_date string   No

The date, in yyyy-mm-dd format, on which the mandate was signed.
payment_method_verification_code string 1000 No

The code provided by the account validator.
emandate_signature string 1000 No

This is the electronic signature returned after successfully completing an e-mandate request through an e-Mandate service.

fraud_control_fields fields

Name Type Length Required Description
fraud_control_field_name string 100 No

List of Fraud Control field names.
fraud_control_field_value string 100 No

List of Fraud Control field values.

proc_field_override fields

proc_field_name proc_field_value
transaction_type

Defines a transaction type for Credit Cards and Tokenized Credit Cards. If a value is not entered, it will default to your client configuration settings. Please note that the values differ per processor. For a list of transaction types, please read our documentation.

Allowed values:

proc_field_value 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.
1 (Chase) Single Transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and consummates the sale via the phone or through the mail. The transaction is not for recurring services or product 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 delayed payment for a specified amount of time.
5 (Chase) Secure Electronic Commerce Transaction - Designates a transaction consummated via the Internet at a 3-D Secure capable merchant and the accountholder is fully authenticated. (e.g. 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 consummated via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (e.g. 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 Issue * 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 consummated via the Internet where the transaction includes the use of transaction encryption such as SSL, 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 but not using ProtectBuy for Cardholder authentication.
8 (Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant consummated 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 consummates 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.
client_3ds_nonce The 3ds enriched nonce used for the card authorization.
payer_auth_reference_id Reference id for 3ds transaction session.
payer_auth_transaction_mode

The transaction mode identifies the channel from which the transactions are originated of Cybersource 3ds 2.0.

Allowed values:

proc_field_value Description
M MOTO
R Retail
S eCommerce
P Mobile Device
T Tablet
payer_auth_transaction_id Authentication Transaction id for 3ds authorization.
end_user_browser_accept_header Browser Accept Header that was used for placing an online order. Some examples might include 'text/html,application/xhtml+xml,application/xml ;q=0.9,*/*;q=0.8'.
end_user_browser_agent Browser that was used for placing an online order. Some examples might include "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0".
end_user_browser_color_depth Browser color depth in bits per pixel. This should be obtained by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth.
end_user_browser_java_enabled_ind Boolean value indicating if the shopper's browser is able to execute Java.
end_user_browser_language Browser supported language(as defined in IETF BCP 47). This should be obtained by using the browser's navigator.language property.
end_user_browser_screen_height Browser total height that was used for placing an online order.
end_user_browser_screen_width Browser total width that was used for placing an online order.
end_user_browser_timezone_offset_mins Time difference between UTC time and the shopper's browser local time, in minutes.
pa_3ds_completion_ind In Adyen, for 3DS v2.0 transaction, if the response of DDC is received within 10sec set this to 'Y', else set this to 'N'.
pa_3ds_trans_status In Adyen, for 3DS v2.0 transaction, if the response of Challenge Shopper is NOT received within 10mins set this to 'U', else set the value from Challenge shopper response.
pa_3ds_termination_url Termination url for 3DS transaction.
pa_machine_id HTTP cookie to be used in the HTTP header for Worldpay 3DS transaction.
sca_exemption_type Defines a exemption type indicator for 3D secure transactions. Depending upon the exemption reason, it can bypass Strong Customer Authentication. If a value is not entered, it will default to your client configuration settings. Please note that the values differ per processor. For a list of exemption types, please read our documentation. (values: -1 - Use client configuration settings for determining the exemption type. 0 - Transaction will be performed with no exemption. 1 - (Chase) Transaction will be performed with low value exemption.)
mandate_collection_method

Use this field to specify how the customer will authorize the mandate for direct debit collection. It is required for ACH, SEPA, and BACS. If the the mandate is collected online, the customer IP address and useragent must be collected and passed in the collection API. If offline, you must collect and maintain the authorization in your records. This is applicable for Stripe Payment Processor.

Allowed values:

proc_field_value Description
0 Offline - Default
1 Online
end_user_ip_address IP address that was used for placing an online order.
end_user_browser_agent Browser that was used for placing an online order. Some examples might include "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0".
bank_acct_holder_type

The type of entity that holds the account. This is applicable for Stripe Payment Processor.

Allowed values:

proc_field_value Description
I This bank account belongs to an individual
C This bank account belongs to a company
kount_session_id kount_session_id is a unique identifier generated by Kount, a fraud prevention and risk management platform for Evertec.

Outputs

Name Type Length Required Description
transaction_id long   No

The unique identifier for a given transaction
proc_cvv_response string   No

The processor return code from CVV validation.
proc_avs_response string   No

Processor return code from address validation
proc_cavv_response string   No

The processors return code for security validation.
proc_status_code string   No

The processor status code
proc_status_text string   No

The processors status description
proc_payment_id string   No

The processor payment ID
proc_auth_code string   No

Authorization code provided by the issuing bank
proc_merch_comments string   No

Additional information passed to payment processor
proc_initial_auth_txn_id string 100 No

Transaction ID from payment processor. If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement.
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
collection_errors object   No

See fields below
proc_fraud_filtering_info object   No

Fraud Filtering Response returned from Payment processor.

See fields below
proc_payment_response_field_list object   No

Payment response fields returned by the processor for further actions if any.

See fields below
collection_payment_method_no long   No

The payment method sequence no for the payment attempted during collection.

collection_errors fields

Name Type Length Required Description
collection_error_code     No  
collection_error_msg     No  

proc_fraud_filtering_info fields

Name Type Length Required Description
proc_fraud_country_status string 100 No

Fraud country status provided by the Payment processor.
proc_fraud_country_code string   No

Fraud country code provided by the Payment processor.

proc_payment_response_field_list fields

Name Type Length Required Description
proc_payment_response_field_name string 100 No

Field name of various response returned by the processor, example: micro_deposit_verify_url.

Allowed values:

Value Description
micro_deposit_verify_url The URL returned by the processor to share with the customer to validate their bank information and perform the micro deposits.
proc_payment_response_field_value string 4000 No

Field value for the corresponding payment response field, example: Actual URL to be used for the micro deposit verification.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.