Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 core api > collect_from_account

collect_from_account

Collects a specified amount from a specified account holder using the electronic method of payment on file.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
account_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
amount_to_collect double 12 The amount of money to collect from the account.
  bill_seq long 22 The unique identifier of the bill sequence number.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  specific_charge_transaction_id long array 38 Unique transaction ID for specific charges, usually when the account holder makes a purchase that is not part of their normal recurring charges.
  alt_pay_method long 1 If you wish to use the account's current form of payment, leave this value empty. If you wish to use an alternate credit card, enter '1' for this value.
  cc_number string 24 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_routing_num string 22 The ABA routing number for the bank holding 'bank_acct_num'
  bank_acct_num string 32 The bank account number.
  bill_company_name string 100 Company name of the billing contact
  bill_first_name string 32 First name of the billing contact
  bill_middle_initial string 1 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
  bill_state_prov string 2 State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  bill_zip string 16 Zip Code of the billing contact
  bill_country string 3 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 of the billing contact
  bill_phone_extension string 20 Phone extension of the billing contact
  bill_cell_phone string 25 Cell phone of the billing contact
  bill_work_phone string 25 Work phone of the billing contact
  bill_work_phone_extension string 20 Work phone extenstion 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 credit card.
  bank_acct_type string 32 The type of bank account being used.   Allowable Values
  bill_address3 string 300 The third line of the billing address
  alt_client_acct_group_id string 100 One-time collections account group to use for this specific call. Default collections group on the account is not changed.
  track_data1 string 1000 Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  track_data2 string 1000 Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  soft_descriptor string   Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field will be ignored if not supported/certified by the payment processor.
  soft_descriptor_customer_service string   Transaction description shown on the buyer's statement that displays a City for Card Present transactions or a Phone Number for Card Not Present transactions. This field will be ignored if not supported/certified by the payment processor.
  payment_application_method long 4 Possible values are 1, 2, or NULL. 1 is FIFO. 2 is First-DUE-First-Out. If NULL, defaults to FIFO
  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). 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 authorise 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. Used in Europe. 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. Used in Europe. Only hyphen and space are allowed to format the bank branch code.
  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.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  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.

Output Arguments

Field Name Field Type Description
transaction_id long The unique identifier for a given transaction
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  
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.

You must to post a comment.
Last modified
10:48, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.