Skip to main content
Aria Knowledge Central

update_order_m

  1. Last updated
  2. Save as PDF

Summary

API Name update_order_m
Class transaction_services_m
Update Version 56

Description

Updates an existing non-subscription order (NSO) for a specified account. Use this to modify order details such as line items, quantities, billing status, or fulfillment information. This API can also be used to release an order that was placed in "Order Held" status (bill_immediately=2 on create_order_m) by changing its billing status to trigger fulfillment and invoicing. This call also has the ability to collect a payment for the invoice by specifying "true" (1) in the bill_immediately field.

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

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

Alternative required field: client_acct_id
order_no long 22 Yes

The unique identifier for an order in the context of an client_no and account_no.
bill_immediately long 1 No

Determines when the order is fulfilled and then billed. If no value is specified then it will act based on the previously given bill_immediately value.

Allowed values:

Value Description
0 Fulfill immediately. Bill on next anniversary.
1 Fulfill immediately. Bill immediately.
2 Held
3 Fulfill on fulfillment date. Bill on the next anniversary bill after the fulfillment date. Note that if the fulfilled date is in the past, then the fulfillment will happen in API itself as in bill_immediately = 0.
4 Fulfill on fulfillment date. Bill on the fulfillment date. Note that if the fulfilled date is in the past, then the fulfillment and billing will happen in API itself as in bill_immediately = 1.
5 Fulfill on fulfillment date. Bill on the next anniversary bill that bills arrears services through the fulfillment date. Note that if the fulfilled date is in the past, then the fulfillment will happen in API itself as in bill_immediately = 0.
alt_pay_method long 1 No

If you want to use the account's current form of payment, leave this field empty. If you want to use an alternate credit card, enter '1' in this field.
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 1 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 2 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_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.
bill_address3 string 300 No

The third line of the billing address.
do_write string 5 No

Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true'

Allowed values:

Value Description
True  
False  
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
alt_inv_template_no long   No

The statement template to use when generating a statement for this order
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.
fulfilled_date string   No

Date on which order is fulfilled.
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.
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: account_no
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_type string 32 No

The type of bank account being used.

Allowed values:

Value Description
savings  
checking  
business  
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.

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.

Outputs

Name Type Length Required Description
transaction_id long   No

Note: This field is deprecated. Aria no longer supports transaction_id.
invoicing_error_code long   No

Note: This field is deprecated. Aria no longer supports invoicing_error_code.
invoicing_error_msg string   No

The text message associated with 'invoicing_error_code'
statement_error_cd long   No

Error code produced when statement generation has failed.
statement_error_msg string   No

The text message associated with 'statement_error_code'
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
invoice_no long   No

The Aria-assigned unique identifier of a given invoice.
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.
total_charges_before_tax double   No

Total charges on this invoice before taxes are applied
total_tax_charges double   No

Total amount of taxes charged
total_charges_after_tax double   No

Subtotal combining the total pre-tax charges and the total taxes charged
total_credit double   No

Sum of all the credits on the invoice
cart_invoice_line_items object   No

All of the items on this order. If do_write was FALSE, these are the line items which would be on the eventual invoice

See fields below
third_party_errors object   No

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.

See fields below
proc_fraud_filtering_info object   No

Fraud Filtering Response returned from Payment processor.

See fields below
invoicing_error_code_2 long   No

The error code generated by Aria when Aria attempted to generate a invoice
threshold_billing_errors object   No

Errors that occurred while performing Threshold Billing and related calculations

See fields below
collection_error_code long   No

If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string   No

The error message associated with collection_error_code.
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.

cart_invoice_line_items fields

Name Type Length Required Description
line_no long   No

Sequential line item
service_no long   No

Service number shown on the invoice
service_name string   No

Service name shown on the invoice
service_is_tax_ind long   No

Whether or not this line item represents a tax charge
line_units double   No

Number of units of the service this line item represents
rate_per_unit double   No

Charge per unit
line_amount double   No

Subtotal for this particular line
description string   No

Long description of this line
date_range_start string   No

(Deprecated) The starting date range for this line item
date_range_end string   No

(Deprecated) The ending date range for this line item
usage_type_no long   No

If this line represents a usage-based charge, the client-defined usage type number this line represents
plan_no long 22 No

The unique plan ID associated with this line
plan_name string   No

The name of the plan associated with this line
client_service_id string 100 No

The client-defined Service ID shown in the invoice.
usage_type_cd string 100 No

An array containing usage_type_cd(s) to denote which usage type(s) to record.
client_plan_id string 100 No

Client-defined Plan ID associated with this invoice.
ref_charge_line_no long   No

The reference charge line number to indicate the item to which the discount applies.
po_num string 100 No

Purchase order number assigned to the account or plan instance.
bill_from_address_no long   No

Address sent as the bill-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.
ship_from_address_no long   No

Address sent as the ship-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.
bill_to_address_no long   No

Address sent as the bill-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item.
ship_to_address_no long   No

Address sent as the ship-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item.
nso_rate_schedule_no long   No

Note: This field is deprecated. Aria no longer supports nso_rate_schedule_no.
client_nso_rate_schedule_id string   No

Note: This field is deprecated. Aria no longer supports client_nso_rate_schedule_id.
rate_seq_no long   No

Tier number of this rate schedule.
rate_schedule_no long   No

Aria-assigned unique identifier for the rate schedule used to price this NSO/Surcharge.
client_rate_schedule_id string   No

Client-defined unique identifier for the rate schedule used to price this NSO.
line_type long   No

Specifies the type of charge or credit associated with this line item.

Allowed values:

Value Description
1 Recurring charge
2 Tax charge
3 Service credit
4 Coupon Credit
5 Activation Charge
6 Usage Charge
7 Recurring Arrears Charge
8 Order Charge
9 Surcharge
custom_rate_ind long   No

Identifies whether this is a custom rate. A value of 1 indicates that it is a custom rate (i.e., the item unit price is overridden at the time of order creation). A value of 0 indicates that it is a standard rate.
installment_term_no long   No

Aria assigned installment term no
installment_no long   No

Aria assigned installment schedule no

third_party_errors fields

Name Type Length Required Description
error_class string   No  
error_code string   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.

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.

threshold_billing_errors fields

Name Type Length Required Description
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.

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.