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



 

Home > Aria Crescendo core api > get_acct_payment_methods_and_terms_m

get_acct_payment_methods_and_terms_m

This API returns a list of payment methods and payment terms present on the account. It can be filtered to include only payment methods or payment terms by using the "payments_returned" input.

For information on error messages generated by this API, see get_acct_payment_methods_and_terms_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.
  payment_method_no long 22 Aria-assigned sequence number for this payment method.
  filter_status long 1 The API will fetch the payment methods based on the filter status.   Allowable Values
  payments_returned long 1 The API will fetch the payment methods and payment terms based on the payments returned.   Allowable Values
  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.

Output Arguments

Field Name Field Type Description
account_payment_methods hash An Array of account payment methods.
brd_arrow.gif bill_first_name string First name of the billing contact.
brd_arrow.gif bill_middle_initial string Middle initial of the billing contact.
brd_arrow.gif bill_last_name string Last name of the billing contact.
brd_arrow.gif bill_company_name string Company name of the billing contact.
brd_arrow.gif bill_address1 string First address line of the billing contact.
brd_arrow.gif bill_address2 string 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.
brd_arrow.gif bill_address3 string The third line of the billing address.
brd_arrow.gif bill_city string City of the billing contact.
brd_arrow.gif bill_locality string Use this field instead of the state_prov field to designate 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 United States, Australia and Canada addresses.
brd_arrow.gif bill_state_prov string 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.
brd_arrow.gif bill_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif bill_postal_cd string Postal code for the billing contact.
brd_arrow.gif bill_address_verification_code string Billing address verification code for the billing contact address.
brd_arrow.gif bill_address_match_score double Billing address match score for the billing contact address.
brd_arrow.gif bill_phone string Phone number of the billing contact.
brd_arrow.gif bill_phone_ext string Phone extension of the billing contact.
brd_arrow.gif bill_cell_phone string Cell phone number of the billing contact.
brd_arrow.gif bill_work_phone string Work phone number of the billing contact.
brd_arrow.gif bill_work_phone_ext string This is the work phone extension for the billing contact work phone.
brd_arrow.gif bill_fax string Fax number of the billing contact.
brd_arrow.gif bill_email string Email of the billing contact.
brd_arrow.gif bill_birthdate string Birthdate of the billing contact.
brd_arrow.gif pay_method_name string The name of this payment method
brd_arrow.gif client_payment_method_id string The method ID for the payment method.
brd_arrow.gif pay_method_description string Description for the pay method.
brd_arrow.gif pay_method_type long This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc. nullable: true default: -1   Allowable Values
brd_arrow.gif suffix string The last 4 digits of the account number
brd_arrow.gif cc_expire_mm long Expiration month for the credit card payment instrument.
brd_arrow.gif cc_expire_yyyy long Expiration year for the credit card payment instrument.
brd_arrow.gif cc_type string The type of credit card used for the original payment.
brd_arrow.gif bank_routing_num string The American Banking Association (ABA) routing number for the financial institution.
brd_arrow.gif bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
brd_arrow.gif bank_swift_cd string 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.
brd_arrow.gif bank_country_cd string 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.
brd_arrow.gif mandate_id string 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.
brd_arrow.gif bank_id_cd string 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.
brd_arrow.gif bank_branch_cd string 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.
brd_arrow.gif status long The staus is "1", the payment method is enabled for the account, if the status is as "0" the payment method is disabled for this account.   Allowable Values
brd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method.
brd_arrow.gif persistent_ind long If true, this payment method persists on the account. Otherwise it was used for a one-time payment.   Allowable Values
brd_arrow.gif from_date string The beginning effective date with time for this payment method on this account.
brd_arrow.gif to_date string The ending effective date with time for this payment method on this account. If none, this is the current form of payment.
brd_arrow.gif bill_info_api_receipt_id string The receipt ID used in the initial API call which created this billing info record.
account_payment_terms hash An Array of account payment terms.
brd_arrow.gif payment_terms_type string Payment Terms Type from Payment Terms configuration. Can be Net Terms or EAN/GLN.   Allowable Values
brd_arrow.gif client_payment_term_id string Client Payment Term ID from Payment Terms configuration.
brd_arrow.gif payment_terms_name string Payment Terms Name from Payment Terms configuration.
brd_arrow.gif payment_terms_no long Payment Terms Number from Payment Terms configuration.
brd_arrow.gif ean_gln_num string 'EAN or GLN Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
brd_arrow.gif ean_gln_requisition_num string 'EAN or GLN Requisition Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.