Skip to main content
Aria Knowledge Central

refresh_token_from_pmt_processor_m

  1. Last updated
  2. Save as PDF

Summary

API Name refresh_token_from_pmt_processor_m
Class account_services_m
Update Version 6.48

Description

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

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
payment_method_no long 22 Yes

The Aria-assigned sequence number for this pay method. Must be a tokenized credit card.

Alternative required field: client_payment_method_id
client_payment_method_id string 100 Yes

The client-defined identifier for the payment method. Must be a tokenized credit card.

Alternative required field: payment_method_no
billing_group_no long 22 No

Billing group number

Alternative field: client_billing_group_id
client_billing_group_id string 100 No

Client-defined unique identifier for billing group

Alternative field: billing_group_no

Outputs

Name Type Length Required Description
bill_first_name string 100 No

First name of the billing contact.
bill_middle_initial string 2 No

Middle initial of the billing contact.
bill_last_name string 100 No

Last name of the billing contact.
bill_company_name string 100 No

Company name of the billing contact.
bill_address1 string 100 No

First address line of the billing contact.
bill_address2 string 100 No

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 100 No

The third line of the billing address.
bill_city string 100 No

City of the billing contact.
bill_locality string 32 No

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 10 No

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 2 No

Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
bill_postal_cd string 15 No

Postal code for the billing contact.
bill_address_verification_code string   No

Billing address verification code for the billing contact address.
bill_address_match_score double   No

Billing address match score for the billing contact address.
bill_phone string 25 No

Phone number of the billing contact.
bill_phone_ext string 10 No

Phone extension of the billing contact.
bill_cell_phone string 20 No

Cell phone number of the billing contact.
bill_work_phone string 25 No

Work phone number of the billing contact.
bill_work_phone_ext string   No

This is the work phone extension for the billing contact work phone.
bill_fax string 25 No

Fax number of the billing contact.
bill_email string 320 No

Email of the billing contact.
bill_birthdate string 10 No

Birthdate of the billing contact.
pay_method_name string   No

The name of this payment method
client_payment_method_id string   No

The method ID for the payment method.
pay_method_description string   No

Description for the pay method.
pay_method_type long   No

Note: This field is deprecated. Aria no longer supports pay_method_type.
suffix string   No

The last 4 digits of the account number
cc_expire_mm long   No

Note: This field is deprecated. Aria no longer supports cc_expire_mm.
cc_expire_yyyy long   No

Note: This field is deprecated. Aria no longer supports cc_expire_yyyy.
cc_type string   No

The type of credit card used for the original payment.
bank_routing_num string   No

The American Banking Association (ABA) routing number for the financial institution.
bill_agreement_id string 32 No

Unique ID of the bill agreement (also referred to as a token).
bank_swift_cd string 15 No

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 No

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 No

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 10 No

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 No

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.
status long   No

Note: This field is deprecated. Aria no longer supports status.
payment_method_no long 22 No

Aria-assigned sequence number for this payment method.
persistent_ind long   No

Note: This field is deprecated. Aria no longer supports persistent_ind.
from_date string   No

The beginning effective date with time for this payment method on this account.
to_date string   No

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   No

The receipt ID used in the initial API call which created this billing info record.
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
cc_expire_mm_2 long   No

Expiration month for the credit card payment instrument.
cc_expire_yyyy_2 long   No

Expiration year for the credit card payment instrument.
persistent_ind_2 long   No

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

Allowed values:

Value Description
0  
1  
pay_method_type_2 long   No

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

Allowed values:

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

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.

Allowed values:

Value 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.
cc_prefix string 6 No

The first 6 digit of the credit card number.
bill_addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the billing contact.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.