Home > Aria Crescendo Documentation > Aria Crescendo core api > create_acct_billing_group_m

create_acct_billing_group_m

This API is used to create a new billing group, optionally assign a new payment method to this billing group, and to optionally assign this new billing group to a plan instance.

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.

For information on error messages generated by this API, see create_acct_billing_group_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  billing_group_name string 100 Billing Group name
  billing_group_description string 1000 Billing group description
  client_billing_group_id string 100 Client-defined unique identifier for billing group
  notify_method long 2 How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).  

Allowable values for notify_method:

Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
15 XML Master File and HTML Email
16 XML Master File and Text Email
17 PDF Master File and HTML Email
  notification_template_group_no long 22 Notification Template Group ID. 

Aria-assigned unique identifier for the notification template group to be associated with the account.
 

client_notification_template_group_id

 string 50

Client-defined unique identifier for the notification template group to be associated with the account.
  statement_template long 22 Statement template No.
  credit_note_template long 22 Credit note template No.
  payment_option string 7 This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'  

Allowable values for payment_option:

Values Description
Methods Methods
Terms Terms
  primary_payment_method_no long 22 Primary payment method ID (Note:The same pay method sequence number cannot be used for a primary and secondary payment method)
  OR      
  client_primary_payment_method_id string 100 Client-defined unique identifier of the primary payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method).
  backup_payment_method_no long 22 Backup payment method ID (Note:The same pay method sequence number cannot be used for a primary and secondary payment method).
  OR      
  client_backup_payment_method_id string 100 Client-defined unique identifier of the backup payment method (Note: The same pay method sequence number cannot be used for the primary and secondary payment method).
  stmt_contact_no long 22 The Aria-assigned unique identifier for the statement contact associated with a billing group on the account. DEPRECATED
  stmt_contact_no_2 long 22 The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
  stmt_first_name string 300 Statement contact first name
  stmt_mi string 2 The Middle Initial of the statement contact.
  stmt_last_name string 300 Statement contact Last name
  stmt_company_name string 100 Company name of the statement contact
  stmt_address1 string 300 First address line of the statement contact
  stmt_address2 string 300 Second address line of the statement contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  stmt_address3 string 300 Third address line of the statement contact
  stmt_city string 300 City of the statement contact
  stmt_locality string 300

Locality of the statement contact. Use this field instead of the <stmt_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.
  stmt_state_prov string 10 State or province of the statement 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 <stmt_locality> field for addresses in those countries.
  stmt_country string 2 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  stmt_postal_cd string 15 Postal/Zip code for the statement contact address.
  stmt_phone string 25 The phone number of the statement contact
  stmt_phone_ext string 10 The extension for the statement contact phone
  stmt_cell_phone string 20 The contact cell phone of the statement contact.
  stmt_work_phone string 25 Work phone number of the statement contact.
  stmt_work_phone_ext string 10 The extension for the statement contact work phone
  stmt_fax string 25 The fax number for the statement contact.
  stmt_email string 320 Email of the statement contact
  stmt_birthdate string 10 The birthdate, in yyyy-mm-dd format, of the statement contact.
  bill_contact_no long 22 The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
  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_company_name string 100 Company 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_address3 string 300 The third line of the billing address.
  bill_city string 300 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_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bill_postal_cd string 15 Postal code for the billing contact.
  bill_phone string 25 Phone number of the billing contact.
  bill_phone_ext string 10 Phone extension of the billing contact.
  bill_cell_phone string 20 Cell phone number of the billing contact.
  bill_work_phone string 25 Work phone number of the billing contact.
  bill_work_phone_ext string 10 This is the work phone extension for the billing contact work phone.
  bill_fax string 25 Fax number of the billing contact.
  bill_email string 320 Email of the billing contact.
  bill_birthdate string 10 Birthdate of the billing contact.
  pay_method_name string 100 Payment method name.
  client_payment_method_id string 100 Client-defined unique identifier for the payment method.
  pay_method_description string 1000 Payment method description
  pay_method_type long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, etc.  

Allowable values for pay_method_type:

Values Description
-1 External Payment
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
8 Click&Buy
10 PayByCash
11 PayPal Express Checkout
13 Tokenized Credit Card
14 Purchase Power
20 NETS
26 Direct Debit
37 Tokenized Direct Debit
48 Tokenized ACH
  cc_num string 20 Credit card number.
  cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  bank_acct_num string 19 The bank account number. The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.
  bank_routing_num string 9 The American Banking Association (ABA) routing number for the financial institution. The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.
  cvv string 6 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.
  track_data1 string 300 Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  track_data2 string 300 Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  bill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token). The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.
  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). 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 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. 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 15 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 15 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_cd string 100 Bank name for the account payment method.
  bank_city_cd string 100 Bank city for the account payment method.
  bank_acct_type string 32 The type of bank account used (for pay_method_type 2). 

Allowable values for bank_acct_type:

Values Description
savings savings
checking checking
business business
Start of master_plans_summary array
  master_plans_summary array   List of master plan instances to be associated with the billing group.
  Field Name Field Type Max Length Description
  brd_arrow.gifplan_instance_no long 22 The unique numberic identifier of the master plan instance.
  OR      
  brd_arrow.gifclient_plan_instance_id string 100 The unique client-defined identifier of the master plan instance.
End of master_plans_summary array
 
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.  

Allowable values for list_start_master_file:

Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
  cc_id long 2 A numeric code indicating the type of credit card.  

Allowable values for cc_id:

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club/Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankoort
  payment_terms_no long 22 Payment terms number assigned to the account.
  OR      
  payment_terms_name string 50 Payment terms name assigned to the account.
  OR      
  client_payment_term_id string 32 Client-defined identifier for the billing group's payment term
  ean_gln_num string 50 'This is the European Article Number or Global Location Number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria's clients' customers and is unique to each customer (account).'
  ean_gln_requisition_num string 50 'This is the European Article Number requisition number or Global Location Number requisition number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria's client's customers and is used to track their individual projects similarly to a purchase order. This number is generated by the individual customer (account) and is not provided by any other party'
  credit_memo_template long 22 Credit template No.
  rebill_template long 22 Rebill template No.
  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.
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name Field Type Max Length Description
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
End of optional_transaction_qualifiers array
 
  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.

Notes:

  • 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 for fraud_filter:

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.
Start of fraud_control_fields array
  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.
  Field Name Field Type Max Length Description
  brd_arrow.giffraud_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:

Values Description
0 disable
1 enable
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifchange_status_on_fraud_filtering_failure string 100 Indicates whether to change the status of the account or master plan instance(s) if:
  • The fraud filtering request returns a failure response; and
  • 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_failure:

Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifstatus_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 master plan instance.
  brd_arrow.gifchange_status_on_fraud_filtering_review 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:

Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifstatus_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 master plan instance.
  brd_arrow.gif
change_mp_status_on_fraud_filtering_cc_prefix_failure		 string 100 Indicates whether to change the status of the master plan instance(s) 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_mp_status_on_fraud_filtering_cc_prefix_failure:

Values Description
0 false
1 true
  brd_arrow.gif
mp_status_on_fraud_filtering_cc_prefix_failure		 string 100 If change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gifchange_mp_status_on_fraud_filtering_cc_number_failure string 100 Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the 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_mp_status_on_fraud_filtering_cc_number_failure:

Values Description
0 false
1 true
  brd_arrow.gifmp_status_on_fraud_filtering_cc_number_failure string 100 If change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gif
change_mp_status_on_fraud_filtering_cc_issuing_country_failure		 string 100 Indicates whether to change the status of the master plan instance(s) 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_mp_status_on_fraud_filtering_cc_issuing_country_failure:

Values Description
0 false
1 true
  brd_arrow.gif
mp_status_on_fraud_filtering_cc_issuing_country_failure		 string 100 If change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gif
change_mp_status_on_fraud_filtering_cc_issuing_country_suspect		 string 100 Indicates whether to change the status of the master plan instance(s) 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_mp_status_on_fraud_filtering_cc_issuing_country_suspect:

Values Description
0 false
1 true
  brd_arrow.gif
mp_status_on_fraud_filtering_cc_issuing_country_suspect		 string 100 If change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
End of fraud_control_fields array
  stmt_email_list_cc string 3000 Comma-delimited list of email addresses to which the statements associated with the billing group should be cc'd (carbon copied).
  stmt_email_list_bcc string 3000 Comma-delimited list of email addresses to which the statements associated with the billing group should be bcc'd (blind carbon copied).
  recurring_processing_model_ind long 1 Defines a recurring payment type for Credit Card and Tokenized Credit Cards. 

Allowable values for recurring_processing_model_ind:

Values Description
0 Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1 Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2 Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3 Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.
  collection_group_bg_row array  

Array of collection groups that should be assigned to the specified billing groups.

For cost savings or for other reasons, you may choose to have payments made with a particular payment method (associated with a billing group) processed by a specific payment gateway. To do so, you can assign a collection group to a billing group by passing values into the collection_group_bg_row array.

Notes:

  • Aria will use this order of precedence when selecting the payment gateway to use for processing a payment:
  1. Collection group assigned to the billing group associated with the master plan instance being invoiced;
  2. Collection group to which the customer is assigned at the account level.
  • Aria now will allow accounts to have multiple billing groups with different collection groups when using tokenized credit cards that were tokenized outside of Aria. To facilitate multiple payment methods, the billing agreement ID (token) is validated against the specific collection group. When there is no collection group specified, then the agreement ID will be validated against the account level collection group. When no collection group at account level or billing group level is specified, then the agreement ID will be validated against the last processor mapped to that client.
 

brd_arrow.gif collections_group_bg_no

 

 

OR

 

 


brd_arrow.gif client_collections_group_bg_id		 long










string
 		 22










100

Aria-assigned identifier of the collection group to assign to the specified billing group.






 

Client-defined identifier of the collection group to assign to the specified billing group.
Start of proc_field_override array
  brd_arrow.gif proc_field_override 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
    brd_arrow.gifbrd_arrow.gif transaction_type 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:

  • 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 for transaction_type:

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.
 

Output Arguments

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.
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.
brd_arrow.gifproc_fraud_country_status string Fraud country status provided by the payment processor.
brd_arrow.gifproc_fraud_country_code string Fraud country code provided by the payment processor.
billing_group_no long The Aria-assigned unique identifier for billing group on this account. DEPRECATED
billing_group_no_2 long The Aria-assigned unique identifier for billing group on this account.
stmt_contact_no long The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
billing_contact_info hash Array
brd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method.
brd_arrow.gif bill_contact_no long The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®