The update_order_m API updates an order for one or more inventory items ordered by a specified account holder. This call can also collect a payment for the invoice by specifying "true" (1) in the bill_immediately field.
Additional Guidance
Input Fields
| Field Name |
Notes |
| <fraud_filter> |
If you set this field to "0", then Aria will ignore all other fraud filtering fields.
If you set this field to "1", then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass "-1" into any fraud filtering field, Aria will ignore that field.
If you set this field to "2", then Aria will apply the values that you specified in the other fraud filtering fields.
|
| <bill_immediately> |
Allowable Values
| Values |
Description |
| 0 |
No. Do not bill immediately. |
| 1 |
Yes. Bill immediately. |
| 2 |
Order Held. This places the billing for the newly created order in a pending state labeled Order Held. The billing status can be updated using the update_order_m API, or through the interface. |
| 3 |
Bill on the next anniversary bill after the fulfillment date. |
| 4 |
Bill on the fulfillment date. |
| 5 |
Bill on the next anniversary bill that bills arrears services through the fulfillment date. |
|
| <do_write> |
Allowable Values
| Values |
Description |
| true |
true |
| false |
false |
|
| <fraud_filter> |
Allowable Values
| Values |
Description |
| 0 |
false (disable)
Note: If you set this field to 0, then Aria will ignore all other fraud filtering fields.
|
| 1 |
true (enable)
Note: If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will ignore that field.
|
| 2 |
Use settings specified at the collection group or payment gateway level.
Note: If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.
|
| |
|
|
| <fraud_filtering_enabled> |
Allowable Values
| Values |
Description |
| 0 |
disable |
| 1 |
enable |
| -1 |
Use settings specified at the collection group or payment gateway level. |
|
| <change_status_on_fraud_filtering_review> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
| -1 |
Use settings specified at the collection group or payment gateway level. |
|
| <change_mp_status_on_fraud_filtering_cc_prefix_failure> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
|
| <change_mp_status_on_fraud_filtering_cc_number_failure> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
|
| <change_mp_status_on_fraud_filtering_cc_issuing_country_failure> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
|
| <change_mp_status_on_fraud_filtering_cc_issuing_country_suspect> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
|
| <bill_immediately> |
Allowable Values
| Values |
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. |
|
Output Fields
| Field Name |
Notes |
| <line_type> |
Allowable Values
| Values |
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 |
|
| <transaction_id> |
Deprecated |
