Home > Aria Crescendo Documentation > Aria Crescendo core api > manage_pending_invoice_m

manage_pending_invoice_m

This API can be used to approve, discard, or regenerate a pending invoice. A pending invoice can be retrieved based on the invoice number or master plan instance ID. After a pending invoice is approved, this call can also collect a payment and send a statement. If the collection fails, the pending invoice will automatically be voided provided the system setting "Auto Void Pending Invoice on Collection Failure" is set to True. This API can also set the custom_status_label, and client_notes at the time of approval, or regeneration.

For information on error messages generated by this API, see manage_pending_invoice_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 invoice_no long 22 The Aria-assigned unique identifier of a given invoice.
  OR      
  acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  master_plan_instance_no long 22 The Master Subscription Plan instance number. This field input is required if invoice_no field is NULL.
  OR      
  client_master_plan_instance_id string 100 The Client-defined Master Subscription Plan instance ID. This field input is required if invoice_no field is NULL.
  action_directive long 8

Identifies which action to take on the pending invoice. If null, defaults to "approve pending invoice".  

Allowable values for action_directive: 

Values Description
1 Approve pending invoice.
2 Discard pending invoice.
3 Regenerate pending invoice.
4 Discard pending invoice and discard usage.
  bill_seq long 22 The unique identifier of the bill sequence number.
  alt_pay_method long 8 If you want to use the account's current form of payment, leave this field empty. If you want to use an alternate card, enter '1' in this field.
  cc_number string 24 Card number.
  cc_expire_mm long 2 Expiration month for the card payment instrument.
  cc_expire_yyyy long 4 Expiration year for the card payment instrument.
  bank_routing_num string 9 The American Banking Association (ABA) routing number for the financial institution. The <bank_acct_num> and <bank_routing_num> with <bank_acct_type> are needed for the Tokenized ACH payment method - 48.
  bank_acct_num string 19 The bank account number. The <bank_acct_num> and <bank_routing_num> with <bank_acct_type> are needed for the Tokenized ACH payment method - 48.
  bill_company_name string 100 Company name of the billing contact.
  bill_first_name string 3 First name of the billing contact.
  bill_middle_initial string 2 Middle initial of the billing contact.
  bill_last_name string 32 Last name of the billing contact.
  bill_address1 string 100 First address line of the billing contact.
  bill_address2 string 100 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 City of the billing contact.
  bill_locality string 32

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_zip string 14 Zip code of the billing contact
  bill_country string 2 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  bill_email string 320 Email of the billing contact.
  bill_phone string 25 Phone number of the billing contact.
  bill_phone_extension 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_extension string 10 Work phone extenston of the billing contact
  bill_drivers_license_no string 32 Driver's license number of the billing contact
  bill_drivers_license_state string 32 Driver’s license state of the billing contact. The official postal service code for all United States and Canada states, provinces, and territories.
  bill_taxpayer_id string 32 Taxpayer ID of the billing contact.
  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 card.
  alt_collect_on_approve string  

If value is non-null, overrides the client setting regarding whether or not to automatically collect after approving the invoice. Leave this value null to use the client setting.  

Allowable values for alt_collect_on_approve:

Values Description
true Automatically perform a collection attempt.
false Do not automatically perform a collection attempt
null If left null, the behavior defaults to the client setting
  alt_send_statement_on_approve string  

If value is non-null, overrides the client setting regarding whether or not to automatically send a statement after approving the invoice. Leave this value null to use the client setting.

Allowable values for alt_send_statement_on_approve: 

Values Description
true Automatically send a statement.
false Do not automatically send a statement.
null If left null, the behavior defaults to the client setting
  cancel_orders_on_discard string  

If true then orders will be canceled if the action directive is set to discard pending invoices.  

Allowable values for cancel_orders_on_discard: 

Values Description
false false
true true
  bank_acct_type string 32

The type of bank account being used.  

Allowable values for bank_acct_type: 

Values Description
savings savings
checking checking
business business
  bill_address3 string 100 The third line of the billing address.
  alt_client_acct_group_id string 100

One-time collection group to use for this specific call.

The default collection group to which the account belongs or the collection group assigned to a billing group will not be changed.
  track_data1 string 300 Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request
  track_data2 string 300 Raw "track 2" data from a swiped card used in a card-present transaction to initiate this request
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions.
  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, including UK-based payments for the Basic Bank Account Number (BBAN) payment method for payments and refunds.

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 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 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 string 100 Bank name for the account payment method.
  bank_city string 100 Bank city for the account payment method.
  custom_status_label string 100 Client-specific custom invoice status that can be edited at the invoice or pending invoice level. Use the "~" symbol to erase the existing status label on the invoice.
  client_notes string 1000 Client-specific custom invoice notes that can be edited at the invoice or pending invoice level
  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.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  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.
  recurring_processing_model_ind long 1

Defines a recurring payment type for Credit Card and Tokenized Credit Cards. 

This feature is available to you if your payment gateway supports Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT).

Note: Currently, for only the Vantiv payment gateway, the value in this field will automatically be set to 2 if your payment gateway or collection group configuration has the Send orderSource as recurring for all transactions option enabled.

Refer to your payment gateway documentation to see if this applies.

Please contact your payment gateway representative for more information.

 

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.
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 or 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
new_invoice_no long The new invoice number generated.
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
client_acct_id string Client-defined account identifier.
billing_group_no long Billing group number
client_billing_group_id string Client-defined unique identifier for billing group
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string The error message associated with collection_error_code.
statement_error_code long Error code for statement generation failure.
statement_error_msg string The text message associated with 'statement_error_code'
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
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.
collection_errors hash  
brd_arrow.gif collection_error_code long If a collection is attempted, returns the error code associated with the collection.
brd_arrow.gif collection_error_msg string The error message associated with collection_error_code.
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 ®