Skip to main content
Knowledge Central
Aria Knowledge Central

create_order_with_plan_m Guide

  1. Last updated
  2. Save as PDF

The create_order_with_plan_m API allows creation of order and plan changes on a single invoice. Installment input fields will override values set on the assigned installment term for the specified account. You can also apply coupons to the plan, including at the plan instance level.

API Specification:

 create_order_with_plan_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>

Error Messages:

 create_order_with_plan_m Error Messages

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.
  • Installment input fields will override values set on the assigned installment term for the specified account.
Input Fields
Field Name Notes
<multiple_coupons> (array) > {<coupon_codes>, <assignment_plan_type>, <assignment_scope>}
Allowable Values for <assignment_plan_type>
Values Description
M/NULL Master Plan, (parent_plan_instance_no/cdid)
S Supp Plan, (supp_plan_instance_no/cdid)
Allowable Values for <assignment_scope>
Values Description
1/NULL MPI Stack level
2 Specific Plan Instance level
3 Specific Plan Instance level to given PI and also to its mandatory child plans.
   
<client_order_id> You can assign a customer order id when creating an order. You can require that Aria enforce uniqueness for this value on active orders by setting the client parameter "Enforce Unique Client Order ID" to "True." Once set, the system will return errors if you attempt to create an order with a <client_order_id> associated with an active order. Once an order becomes inactive, you can reuse a <client_order_id>.
<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:

  1. value passed into this field
  2. collection group configuration
  3. payment gateway configuration
  4. 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.
<installment_amount>

If <installment_amount> is specified, Arial will ignore the <installment_term_length> field.
<installment_term_length> For installment_type = 2, the input will be used jointly with the interval type. For installment_type = 1, this will be the number of statements that the installment amount will be part of.
<aligned_installment>
Allowable values
Values Description
Y Aligned with existing master plan instance
N Its own installment schedule and due dates
<installment_term_type>
Allowable values
Values Description
M Months
W Weeks
D Days
<installment_lump_sum_type>
Allowable values
Values Description
P proportionately split charge/tax
T for purchase tax only
<installment_aligned_lump_sum>
Allowable values
Values Description
0 Aligned with when an invoice is created
1 Aligned with the 1st installment
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
<independent_installment_date> This is honored only when <aligned_installment> = N AND when <client_installment_term_id> or <installment_term_no> is passed. Otherwise, this will generate an error or be ignored.
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    1. core api
    2. orders