create_order_with_plan_m Guide
- Last updated
-
-
Save as PDF
Allows creation of order and plan changes on a single invoice.
Additional Guidance:
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.
Input Fields
| Field Name: |
Notes: |
| <order_qualifier_list> |
You can specify up to nine (9) qualifiers in this hash. |
| <fraud_filter> |
- 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.
- 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.
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.
|
|
| <transaction_type> |
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).
The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
- Configuration > Payments > Payment Gateways > Chase Paymentech/Vantiv > Gateway Options; and
- Configuration > Payments > Collection Groups > Chase Paymentech/Vantiv > Collection Group Options.
Currently, only Chase Paymentech and Vantiv support this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.
Aria will use this order of precedence to determine the transaction type:
- value passed into this field
- collection group configuration
- payment gateway configuration
- transaction type that you specified in the <recurring_processing_model_ind> field
Allowable values
| Values |
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. (default) |
| 1 |
(Chase) Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products 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 payment delayed for a specified amount of time. |
| 5 |
(Chase) Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 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 completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 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 issuer * 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 completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), 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 in which ProtectBuy for Cardholder authentication was not used. |
| 8 |
(Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed 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 completes 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. |
|
| <assignment_directive> |
Allowable values
| Values |
Description |
| 2 |
(Default) Perform the requested plan change immediately, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment. No new recurring charges or credits are generated when no proration occurs. |
| 3 |
Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new recurring charges or credits are generated when no proration occurs. |
| 4 |
Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION. |
| 5 |
Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when cancelling a supplemental plan. |
| 6 |
Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when assigning a supplemental plan. |
|
| <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. |
|
| <bank_acct_type> |
Allowable values
| Values |
Description |
| savings |
savings |
| checking |
checking |
| business |
business |
|
| <do_write> |
Allowable values
| Values |
Description |
| true |
true |
| false |
false |
|
| <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_failure> |
Allowable values
| Values |
Description |
| 0 |
false |
| 1 |
true |
| -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 |
|
| <include_plan_instance_queue> |
Allowable values
| Values |
Description |
| false |
Scheduled plan changes will not be returned in the plan_instance_queue array (default). |
| true |
Scheduled plan changes will be returned in the plan_instance_queue array. |
|
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 |
|
| <service_is_tax_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <transaction_id> |
Deprecated |
