This API allows the creation of order and plan changes on a single invoice.
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.
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. | ||||||||||||||||||||||||||||
order_line_items_list | array | |||||||||||||||||||||||||||||||
![]() |
string | 100 | The client-defined product identifier | |||||||||||||||||||||||||||||
![]() |
double | 38 | The number of this item being purchased | |||||||||||||||||||||||||||||
![]() |
double | 38 | The subtotal of this line | |||||||||||||||||||||||||||||
![]() |
double | 38 | The discount per unit applied and included in the amount | |||||||||||||||||||||||||||||
![]() |
string | 3000 | Any available client-supplied comments for this line | |||||||||||||||||||||||||||||
![]() |
long | Aria-assigned unique identifier for the rate schedule. | ||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
![]() |
string | 3000 | Client-defined unique identifier for the rate schedule. If both are not specified, the default rate schedule for the account's currency is chosen. | |||||||||||||||||||||||||||||
cart_supp_plans | array | |||||||||||||||||||||||||||||||
![]() |
long | The supplemental plan number. | ||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
![]() |
string | 100 | The client-defined supplemental plan number. | |||||||||||||||||||||||||||||
![]() |
long | 38 | Number of units for the supplemental plan | |||||||||||||||||||||||||||||
![]() |
long | 8 | Rule to apply to this assignment/de-assignment request, specifying: the date the assignment takes place (immediately or on the account's anniversary date), and the proration rule to apply (per client's default rules for proration, that is, prorate on plan assignment or force proration on or off for each request).
Allowable values for assignment_directive:
|
|||||||||||||||||||||||||||||
client_order_id | string | 38 | This is the client-assigned order identifier. | |||||||||||||||||||||||||||||
coupon_code | string | 30 | (DEPRECATED) This parameter is deprecated as of Release 6.21 and replaced with coupon_codes. The code of the coupon to which to apply the discount. If code is not valid for any reason, an appropriate error code is returned and the entire transaction (including the supp plan assignment and any possible invoice creation) is rolled back. | |||||||||||||||||||||||||||||
comments | string | 3000 | Additional explanatory text relating to this API call. | |||||||||||||||||||||||||||||
do_write | string | 1000 | Boolean indicator informing Aria whether or not to actually perform the requested plan assignment/de-assignment. If 'false' is passed in this field Aria will, if applicable, calculate any potential proration effect that would result from this call and return that value in the output field 'proration_result_amount' described below without actually performing the requested operation or charging/crediting the account. This is useful to interfaces that wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it. Do_write defaults to 'true'
Allowable values for do_write:
|
|||||||||||||||||||||||||||||
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |||||||||||||||||||||||||||||
bill_seq | long | 22 | The billing sequence number | |||||||||||||||||||||||||||||
alt_pay_method | long | 38 | If you wish to use the account's current form of payment, leave this value empty. If you wish to use an alternate card, enter '1' for this value. | |||||||||||||||||||||||||||||
cc_number | string | 24 | Card number. | |||||||||||||||||||||||||||||
cc_expire_mm | long | Expiration month for the card payment instrument. | ||||||||||||||||||||||||||||||
cc_expire_yyyy | long | Expiration year for the card payment instrument. | ||||||||||||||||||||||||||||||
bank_routing_num | string | 9 | The ABA routing number for the bank holding 'bank_acct_num'. This field along with <bank_acct_num> along with the <bank_acct_type> must be passed in for payment method 48 (Tokenized ACH). | |||||||||||||||||||||||||||||
bank_acct_num | string | 19 | The bank account number. This field along with <bank_routing_num> along with the <bank_acct_type> must be passed in for payment method 48 (Tokenized ACH). | |||||||||||||||||||||||||||||
bill_company_name | string | 100 | Company name of the billing contact | |||||||||||||||||||||||||||||
bill_first_name | string | 300 | First name of the billing contact | |||||||||||||||||||||||||||||
bill_middle_initial | string | 2 | Middle Initial of the billing contact | |||||||||||||||||||||||||||||
bill_last_name | string | 300 | Last name of the billing contact | |||||||||||||||||||||||||||||
bill_address1 | string | 300 | First address line of the billing contact | |||||||||||||||||||||||||||||
bill_address2 | string | 300 | 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 | 300 |
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 | 15 | Zip Code of the billing contact | |||||||||||||||||||||||||||||
bill_country | string | 25 | 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 | Phone of the billing contact | ||||||||||||||||||||||||||||||
bill_phone_extension | string | Phone extension of the billing contact | ||||||||||||||||||||||||||||||
bill_cell_phone | string | Cell phone of the billing contact | ||||||||||||||||||||||||||||||
bill_work_phone | string | Work phone of the billing contact | ||||||||||||||||||||||||||||||
bill_work_phone_extension | string | Work phone extension of the billing contact | ||||||||||||||||||||||||||||||
cvv | string | 1000 | 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 | The type of bank account being used.
Allowable values for bank_acct_type:
|
||||||||||||||||||||||||||||||
bill_address3 | string | 300 | The third line of the billing address | |||||||||||||||||||||||||||||
track_data1 | string | 1000 | Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request | |||||||||||||||||||||||||||||
track_data2 | string | 1000 | 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. | ||||||||||||||||||||||||||||||
alt_inv_template_no | long | The invoice template number to use for this order, if different from the default template | ||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||
client_alt_inv_template_id | string | 100 | The client alternate invoice template number to use for this order, if different from the default template | |||||||||||||||||||||||||||||
sync_mstr_bill_dates_override | long | 4 | Overrides the client-level setting that determines whether or not master plan billing dates should be reset when assigning a new supplemental plan. If this value is left empty, the client-level setting will take effect.
Allowable values for sync_mstr_bill_dates_override:
|
|||||||||||||||||||||||||||||
![]() |
string array | 30 | associate multiple coupons. | |||||||||||||||||||||||||||||
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). 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 authorize 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. | |||||||||||||||||||||||||||||
statement_message | string | 1000 | Alternate contact details for orders. | |||||||||||||||||||||||||||||
order_comments | string | 3000 | Comments for this order | |||||||||||||||||||||||||||||
existing_pay_method_cvv | string | 6 | Sends the CVV value of the current card on file. | |||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
![]() |
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. | |||||||||||||||||||||||||||||
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.
Allowable values for fraud_filter:
|
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
fraud_control_field_name | Field Type | Max Length | fraud_control_field_value:
|
|||||||||||||||||||||||||||||
![]() fraud_filtering_enabled |
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:
Allowable values for change_status_on_fraud_filtering_failure:
|
|||||||||||||||||||||||||||||
![]() 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 account. | |||||||||||||||||||||||||||||
![]() |
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:
|
|||||||||||||||||||||||||||||
![]() 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 account. | |||||||||||||||||||||||||||||
![]() change_status_on_fraud_filtering_cc_prefix_failure |
string | 100 | Indicates whether to change the status of the account 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_status_on_fraud_filtering_cc_prefix_failure:
|
|||||||||||||||||||||||||||||
![]() status_on_fraud_filtering_cc_prefix_failure |
string | 100 | If change_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post) | |||||||||||||||||||||||||||||
![]() change_status_on_fraud_filtering_cc_number_failure |
string | 100 | Indicates whether to change the status of the account if the purchase transaction failed 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_status_on_fraud_filtering_cc_number_failure:
|
|||||||||||||||||||||||||||||
![]() status_on_fraud_filtering_cc_number_failure |
string | 100 | If change_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post) | |||||||||||||||||||||||||||||
![]() change_status_on_fraud_filtering_cc_issuing_country_failure |
string | 100 | Indicates whether to change the status of the account 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_status_on_fraud_filtering_cc_issuing_country_failure:
|
|||||||||||||||||||||||||||||
![]() status_on_fraud_filtering_cc_issuing_country_failure |
string | 100 | If change_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post) | |||||||||||||||||||||||||||||
![]() |
string | 100 | Indicates whether to change the status of the account 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_status_on_fraud_filtering_cc_issuing_country_suspect:
|
|||||||||||||||||||||||||||||
![]() status_on_fraud_filtering_cc_issuing_country_suspect |
string | 100 | If change_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the account. (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 | ||||||
---|---|---|---|---|---|---|---|---|
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. | ||||||
order_no | long | The unique identifier for an order in the context of an client_no and account_no. | ||||||
invoice_no | long | The unique identifier of a given invoice. | ||||||
invoice_line_items_list | hash | |||||||
![]() |
long | The invoice line number associated with the current record. | ||||||
![]() |
long | Aria-assigned unique service identifier | ||||||
![]() |
string | The name corresponding to this line item's service code. | ||||||
![]() |
long | A boolean value indicating the service is actually a tax. (true/1=yes, false/0=no)
Allowable values for service_is_tax_ind:
|
||||||
![]() |
double | Number of units for the specified invoice line. | ||||||
![]() |
double | The monetary rate per unit of service. | ||||||
![]() |
double | The total line amount for this invoice line. | ||||||
![]() |
string | Description of the invoice line item. | ||||||
![]() |
string | The beginning date of the date range | ||||||
![]() |
string | The ending date of the date range | ||||||
![]() |
long | The usage type of the usage units specified. | ||||||
![]() |
long | The plan number associated with the usage asserted in this invoice. | ||||||
![]() |
string | The name of the plan for the specified plan_no. | ||||||
![]() |
string | Client-defined service identifier. | ||||||
![]() |
string | The usage type code of the usage type specified. | ||||||
![]() |
string | Client-defined Plan ID associated with the usage asserted in this invoice. | ||||||
![]() |
long | The reference charge line number to indicate the item to which the discount applies. | ||||||
![]() |
string | Name for the rate schedule to be created | ||||||
![]() |
string | Client-defined unique identifier | ||||||
invoicing_error_code | long | The error code generated by Aria when Aria attempted to generate a invoice | ||||||
invoicing_error_msg | string | The text message associated with 'invoicing_error_code' | ||||||
collection_error_code | long | If a collection is attempted, returns the error code associated with the collection. | ||||||
collection_error_msg | string | The error message associated with collection_error_code. | ||||||
statement_error_code | long | The error code generated by Aria when Aria attempted to generate a statement | ||||||
statement_error_msg | string | The text message associated with 'statement_error_code' | ||||||
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. | ||||||
third_party_errors | hash | Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return. | ||||||
![]() |
string | Type of error code being represented, such as taxation | ||||||
![]() |
string | Aria-assigned error identifier. 0 indicates no error. | ||||||
![]() |
string | Description of any error that occurred. "OK" if there was no error. | ||||||
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. |