State or province of the billing contact.
The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.
Collects a specified amount from a specified account holder using the electronic method of payment on file.
Note: Inputs passed to this API call will override any fraud options that you specified in your payment gateway, collection group, or Direct Post settings, unless stated otherwise below.
For information about error messages generated by this API, see collect_from_account_m Error Messages.
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. | |||||||||||||||||||||||||||||
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | |||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
client_acct_id | string | 50 |
Client-defined account identifier. Note: If you pass in a <client_acct_id> and an <acct_no>, Aria will use this order of precedence to decide which account to take action on:
|
|||||||||||||||||||||||||||||
amount_to_collect | double | 12 | The amount of money to collect from the account. If invoice_no, master_plan_instance_no, or client_master_plan_instance_id is provided, then amount_to_collect is not required. If no invoice(s) or master plan instance(s) are specified, then amount_to_collect is required. | |||||||||||||||||||||||||||||
payment_method_no | long | 22 | Aria-assigned sequence number for this payment method. | |||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
client_payment_method_id | string | 32 | Client-defined ID for this payment method. | |||||||||||||||||||||||||||||
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |||||||||||||||||||||||||||||
specific_charge_transaction_id | long array | 22 | Unique transaction ID for specific charges, usually when the account holder makes a purchase that is not part of their normal recurring charges. | |||||||||||||||||||||||||||||
alt_pay_method | long | 2 | If you want to use the account's current form of payment, leave this field empty. If you want to use an alternate card, enter '1' in this field. This field is required if the below alternate billing info fields are to be honored. | |||||||||||||||||||||||||||||
cc_number | string | 24 | Card number. | |||||||||||||||||||||||||||||
cc_expire_mm | long | 2 | Expiration month for the card payment instrument. | |||||||||||||||||||||||||||||
cc_expire_yyyy | long | 4 | Expiration year for the card payment instrument. | |||||||||||||||||||||||||||||
bank_routing_num | string | 22 | The American Banking Association (ABA) routing number for the financial institution. The <bank_acct_num> and <bank_routing_no> along with the <bank_acct_type> are needed for the Tokenized ACH payment method - 48. | |||||||||||||||||||||||||||||
bank_acct_num | string | 32 | The bank account number. The <bank_acct_num> and <bank_routing_no> along with the <bank_acct_type> are needed for the Tokenized ACH payment method - 48. | |||||||||||||||||||||||||||||
bill_company_name | string | 100 | Company name of the billing contact. | |||||||||||||||||||||||||||||
bill_first_name | string | 32 | First name of the billing contact. | |||||||||||||||||||||||||||||
bill_middle_initial | string | 2 | Middle initial of the billing contact. | |||||||||||||||||||||||||||||
bill_last_name | string | 32 | Last name of the billing contact. | |||||||||||||||||||||||||||||
bill_address1 | string | 100 | First address line of the billing contact. | |||||||||||||||||||||||||||||
bill_address2 | string | 100 | 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 | City of the billing contact. | |||||||||||||||||||||||||||||
bill_locality | string | 32 |
Locality of the billing contact. Use this field instead of the <bill_state_prov> field to identify 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 addresses in the United States, Australia, and Canada. |
|||||||||||||||||||||||||||||
bill_state_prov | string | 10 |
State or province of the billing contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries. This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <bill_locality> field for addresses in those countries. |
|||||||||||||||||||||||||||||
bill_zip | string | 16 | Zip Code of the billing contact | |||||||||||||||||||||||||||||
bill_country | string | 3 | Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |||||||||||||||||||||||||||||
bill_email | string | 320 | Email of the billing contact. | |||||||||||||||||||||||||||||
bill_phone | string | 25 | Phone number of the billing contact. | |||||||||||||||||||||||||||||
bill_phone_extension | string | 20 | Phone extension of the billing contact. | |||||||||||||||||||||||||||||
bill_cell_phone | string | 20 | Cell phone number of the billing contact. | |||||||||||||||||||||||||||||
bill_work_phone | string | 25 | Work phone number of the billing contact. | |||||||||||||||||||||||||||||
bill_work_phone_extension | string | 20 | Work phone extension of the billing contact | |||||||||||||||||||||||||||||
bill_drivers_license_no | string | 32 | Driver's license number of the billing contact | |||||||||||||||||||||||||||||
bill_drivers_license_state | string | 32 | Driver’s license state of the billing contact. The official postal service code for all United States and Canada states, provinces, and territories. | |||||||||||||||||||||||||||||
bill_taxpayer_id | string | 32 | Taxpayer ID of the billing contact. | |||||||||||||||||||||||||||||
cvv | string | 6 | Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the card. | |||||||||||||||||||||||||||||
bank_acct_type | string | 32 |
The type of bank account being used. Allowable values for bank_acct_type:
|
|||||||||||||||||||||||||||||
bill_address3 | string | 100 | The third line of the billing address. | |||||||||||||||||||||||||||||
alt_client_acct_group_id | string | 100 |
One-time collection group to use for this specific call. The default collection group to which the account belongs or the collection group assigned to a billing group will not be changed. |
|||||||||||||||||||||||||||||
track_data1 | string | 300 | Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request | |||||||||||||||||||||||||||||
track_data2 | string | 300 | Raw "track 2" data from a swiped card used in a card-present transaction to initiate this request | |||||||||||||||||||||||||||||
soft_descriptor | string | 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 | 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. | ||||||||||||||||||||||||||||||
payment_application_method | long | 1 |
How the payment should be applied. Note: The value that you pass into the this field will override your selection for the Default Payment Collection Method parameter (in the Aria application under Configuration > Payments > Payment Settings). Allowable values for payment_application_method:
|
|||||||||||||||||||||||||||||
iban | string | 50 | 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 | 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 | 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 | 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 |
Used for the Direct Debit payment method, including UK-based payments for the Basic Bank Account Number (BBAN) payment method for payments and refunds. A mandate is signed by the debtor to authorise the creditor to collect a payment and to instruct the bank of the debtor to pay those collections. |
|||||||||||||||||||||||||||||
bank_id_cd | string | 10 | 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 | 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. | |||||||||||||||||||||||||||||
bank_name | string | 100 | Bank name for the account payment method. | |||||||||||||||||||||||||||||
bank_city | string | 100 | Bank city for the account payment method. | |||||||||||||||||||||||||||||
invoice_no | long array | 22 | The Aria-assigned unique identifier for invoices. If a single invoice is provided, collection is attempted for the amount due for that invoice. If multiple invoices are provided, one collection is attempted for the combined amount due for all invoices specified. Payment is automatically applied to the invoice line items for the invoices provided (first-in, first-out). Note that invoice_no takes precedence over master_plan_instance_no, which in turn takes precedence over client_master_plan_instance_id. | |||||||||||||||||||||||||||||
Start of specific_master_plan_instances_list array | ||||||||||||||||||||||||||||||||
specific_master_plan_instances_list | array | A list of specific master plan instance charges, see below | ||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||
long | 22 | The Aria-assigned unique identifier for master plan instances (MPI). If a single MPI is provided, collection will be attempted for the total or current balance due (based on the client parameter setting) of that MPI. If multiple MPIs are provided, one collection will be attempted for the combined total / current balance due for all MPIs specified. Payment will be automatically applied to the invoice line items for the MPIs provided (first-in, first-out). Note that invoice_no takes precedence over master_plan_instance_no, which in turn takes precedence over client_master_plan_instance_id. | ||||||||||||||||||||||||||||||
string | 100 | The client-defined unique identifier for master plan instances (MPI). If a single MPI is provided, collection will be attempted for the total or current balance due (based on the client parameter setting) of that MPI. If multiple MPIs are provided, one collection will be attempted for the combined total / current balance due for all MPIs specified. Payment will be automatically applied to the invoice line items for the MPIs provided (first-in, first-out). Note that invoice_no takes precedence over master_plan_instance_no, which in turn takes precedence over client_master_plan_instance_id. | ||||||||||||||||||||||||||||||
End of specific_master_plan_instances_list array | ||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||
Start of optional_transaction_qualifiers array | ||||||||||||||||||||||||||||||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||
string | 100 | Name of the field you want to associate with this API call. | ||||||||||||||||||||||||||||||
string | 100 | Corresponding value of the field you want to associate with this API call. | ||||||||||||||||||||||||||||||
End of optional_transaction_qualifiers array | ||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||
fraud_filter | long | 1 |
Enables or disables fraud filtering. If no value is provided, the system will default to 2. 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. Notes:
Allowable values for fraud_filter:
|
|||||||||||||||||||||||||||||
Start of fraud_control_fields array | ||||||||||||||||||||||||||||||||
fraud_control_fields | array |
Your chosen fraud protection options passed as an array of fraud_control_field_name/fraud_control_field_value key-value pairs. This array allows you to specify your fraud filtering options. To use fraud filtering, you must have fraud functionality enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation. The allowable fields and values for the key-value pairs are highlighted in blue below. |
||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||
string | 100 |
Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (disable), then Aria will ignore all other fraud filtering fields. Allowable values for fraud_filtering_enabled:
|
||||||||||||||||||||||||||||||
string | 100 | Indicates whether to change the status of the account or master plan instance(s) if:
Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable values for change_status_on_fraud_filtering_failure:
|
||||||||||||||||||||||||||||||
string | 100 | If change_status _on_fraud_filtering_failure is set to true and the fraud filtering request returns a failure response, use this field to indicate the desired status of the master plan instance. | ||||||||||||||||||||||||||||||
string | 100 |
Indicates whether to change the status of the account or master plan instance(s) if fraud_filtering_enabled is set to 1 (enable). Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable values for change_status_on_fraud_filtering_review:
|
||||||||||||||||||||||||||||||
string | 100 | If change_status _on_fraud_filtering_review is set to 1 (true), use this field to indicate the desired status of the master plan instance. | ||||||||||||||||||||||||||||||
string | 100 |
Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values for change_mp_status_on_fraud_filtering_cc_prefix_failure:
|
||||||||||||||||||||||||||||||
string | 100 | If change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post) | ||||||||||||||||||||||||||||||
string | 100 |
Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the the fraud filtering check for the credit card number. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values for change_mp_status_on_fraud_filtering_cc_number_failure:
|
||||||||||||||||||||||||||||||
string | 100 | If change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post) | ||||||||||||||||||||||||||||||
change_mp_status_on_fraud_filtering_cc_issuing_country_failure |
string | 100 |
Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values for change_mp_status_on_fraud_filtering_cc_issuing_country_failure:
|
|||||||||||||||||||||||||||||
mp_status_on_fraud_filtering_cc_issuing_country_failure |
string | 100 | If change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post) | |||||||||||||||||||||||||||||
change_mp_status_on_fraud_filtering_cc_issuing_country_suspect |
string | 100 |
Indicates whether to change the status of the master plan instance(s) if the fraud filtering check for the credit card issuing country returned a "suspect" value. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable values for change_mp_status_on_fraud_filtering_cc_issuing_country_suspect:
|
|||||||||||||||||||||||||||||
mp_status_on_fraud_filtering_cc_issuing_country_suspect |
string | 100 | If change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post) | |||||||||||||||||||||||||||||
End of fraud_control_fields array | ||||||||||||||||||||||||||||||||
Req | Field Name | Field Type | Max Length | Description | ||||||||||||||||||||||||||||
recurring_processing_model_ind | long |
1 |
Defines a recurring payment type for Credit Card and Tokenized Credit Cards. This feature is available to you if your payment gateway supports Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT). Note: Currently, for only the Vantiv payment gateway, the value in this field will automatically be set to 2 if your payment gateway or collection group configuration has the Send orderSource as recurring for all transactions option enabled. Refer to your payment gateway documentation to see if this applies. Please contact your payment gateway representative for more information. Allowable values for recurring_processing_model_ind:
|
|||||||||||||||||||||||||||||
Start of proc_field_override array | ||||||||||||||||||||||||||||||||
array |
Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs. The allowable field(s) and values for the key-value pairs are listed below. |
|||||||||||||||||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||||||||||||||
string | 2 |
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). Notes:
Aria will use this order of precedence to determine the transaction type:
Allowable values for transaction_type:
|
Field Name | Field Type | Description |
---|---|---|
transaction_id | long | The unique identifier for a given transaction |
proc_cvv_response | string | The processor return code from CVV validation. |
proc_avs_response | string | Processor return code from address validation |
proc_cavv_response | string | The processors return code for security validation. |
proc_status_code | string | The processor status code |
proc_status_text | string | The processors status description |
proc_payment_id | string | The processor payment ID |
proc_auth_code | string | Authorization code provided by the issuing bank |
proc_merch_comments | string | Additional information passed to payment processor |
proc_fraud_filter_response | string | The fraud filtering information provided by the payment processor in response to a fraud filtering request. |
proc_fraud_filtering_info | array | The fraud filtering information provided by the payment processor as described below. |
string | Fraud country status provided by the payment processor. | |
string | Fraud country code provided by the payment processor. | |
error_code | long | Aria-assigned error identifier. 0 indicates no error. |
error_msg | string | Description of any error that occurred. "OK" if there was no error. |
collection_errors | hash | |
long | If a collection is attempted, returns the error code associated with the collection. | |
string | The error message associated with collection_error_code. | |
proc_initial_auth_txn_id | string | 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. |