Home > Aria Crescendo Documentation > Aria Crescendo core api > refresh_token_from_pmt_processor_m

refresh_token_from_pmt_processor_m

Sends an already-tokenized credit card saved in Aria to the payment processor which generated that token to check for updated information .

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.
  OR      
  client_acct_id string 50 Client-defined account identifier.
required-icon.png payment_method_no long 22 The Aria-assigned sequence number for this pay method. Must be a tokenized credit card.
  OR      
  client_payment_method_id string 100 The client-defined identifier for the payment method. Must be a tokenized credit card.
  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
bill_first_name string First name of the billing contact.
bill_middle_initial string Middle initial of the billing contact.
bill_last_name string Last name of the billing contact.
bill_company_name string Company name of the billing contact.
bill_address1 string First address line of the billing contact.
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.
bill_address3 string The third line of the billing address.
bill_city string City of the billing contact.
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.
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.
bill_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bill_postal_cd string Postal code for the billing contact.
bill_addr_method_cd string This field denotes the tax address method code which was used to generate the geo code of the billing contact.
bill_address_verification_code string Billing address verification code for the billing contact address.
bill_address_match_score double Billing address match score for the billing contact address.
bill_phone string Phone number of the billing contact.
bill_phone_ext string Phone extension of the billing contact.
bill_cell_phone string Cell phone number of the billing contact.
bill_work_phone string Work phone number of the billing contact.
bill_work_phone_ext string This is the work phone extension for the billing contact work phone.
bill_fax string Fax number of the billing contact.
bill_email string Email of the billing contact.
bill_birthdate string Birthdate of the billing contact.
pay_method_name string The name of this payment method
client_payment_method_id string The method ID for the payment method.
pay_method_description string Description for the pay method.
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 for pay_method_type: 

Values Description
1 Credit card
2 Electronic Check (ACH)
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
9 Net Terms 0
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
20 NETS
26 Direct Debit
pay_method_type_2 long

This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Pad, Net Terms, etc. nullable: true default: -1 

Allowable values for pay_method_type_2:

Values Description
1 Credit card
2 Electronic Check (ACH)
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
9 Net Terms 0
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
20 NETS
26 Direct Debit
pay    
suffix string The last 4 digits of the account number
cc_expire_mm long Expiration month for the credit card payment instrument. DEPRECATED
cc_expire_mm_2 long Expiration month for the credit card payment instrument.
cc_expire_yyyy long Expiration year for the credit card payment instrument. DEPRECATED
cc_expire_yyyy_2 long Expiration year for the credit card payment instrument.
cc_type string The type of credit card used for the original payment.
bank_routing_num string The American Banking Association (ABA) routing number for the financial institution.
bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
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.
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.
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.
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.
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.
status long

The status 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 for status: 

Values Description
0 The status is "0", the payment method is disabled for the account.
1 The status is "1", the payment method is enabled for the account.
status_2 long

The status 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 for status_2: 

Values Description
0 The status is "0", the payment method is disabled for the account.
1 The status is "1", the payment method is enabled for the account.
payment_method_no long Aria-assigned sequence number for this payment method.
persistent_ind long

If true, this payment method persists on the account. Otherwise it was used for a one-time payment.  

Allowable values for persistent_ind: 

Values Description
0 0
1 1
persistent_ind_2 long

If true, this payment method persists on the account. Otherwise it was used for a on-time payment.

Allowable values for persistent_ind_2: 

Values Description
0 0
1 1
from_date string The beginning effective date with time for this payment method on this account.
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.
bill_info_api_receipt_id string The receipt ID used in the initial API call which created this billing info record.
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.
Powered by CXone Expert ®