Payment Method References in Aria Core API Methods
Overview
Aria Core API methods use a numeric identifier to represent the type of payment method associated with an account, billing group, transaction, or payment record. This identifier appears under several field names depending on the API method, but all refer to the same set of underlying values. This article provides the comprehensive reference for those values, identifies all field names that carry them, and documents where individual APIs expose a different or reduced subset.
This article covers:
- The comprehensive payment method type value reference
- Synonymous field names and the API methods that use each one
- Value set discrepancies across API methods
Note: Not every API method supports every value in the comprehensive reference table. The values available in a given API depend on whether the field is an input or a response field, and on the payment method types that are valid in that operational context. See Value Set Discrepancies for details.
Comprehensive Payment Method Type Reference
The table below lists all current payment method type values. Deprecated Net Terms values are excluded; for Net Terms payment configurations, use Payment Terms instead.
| Value | Payment Method |
|---|---|
| -3 | Cash Credit |
| -2 | Internal Write-off |
| -1 | External Payment |
| 1 | Credit Card |
| 2 | Electronic Check (ACH) |
| 11 | PayPal Express Checkout |
| 13 | Tokenized Credit Card |
| 20 | NETS |
| 21 | FIK |
| 26 | Direct Debit |
| 27 | Direct Debit – IBAN |
| 28 | Direct Debit – BBAN |
| 30 | Boleto Bancario |
| 32 | iDEAL |
| 33 | WebMoney |
| 34 | Yandex |
| 35 | PaySafeCard |
| 36 | SOFORT |
| 37 | Tokenized Direct Debit |
| 38 | ApplePay – Indirect |
| 39 | PayPal Express Checkout – Indirect |
| 40 | Merchant Specific Gift Card |
| 41 | Giropay |
| 42 | Klarna |
| 43 | Tokenized Klarna |
| 44 | Qiwi |
| 45 | Tokenized Qiwi |
| 46 | Swish |
| 47 | Tokenized ApplePay |
| 48 | Tokenized ACH Payment |
| 51 | Tokenized GooglePay |
Synonymous Field Names
The following field names all represent the same concept: the numeric identifier for the payment method type on an account, billing group, or transaction. pay_method_type is the primary field name used across the majority of API methods. The others appear in specific APIs where the field name reflects context (primary vs. backup payment method, payment method in a specific operation, and so on).
pay_method_type
The primary payment method type field. It appears as both a request input and a response output depending on the API method.
Request (input) APIs:
- create_acct_billing_group_m
- create_acct_complete_m
- record_alternative_payment_m
- update_acct_billing_group_m
- update_acct_complete_m
- update_payment_method_m
Response (output) APIs:
primary_pay_method_type
Returns the payment method type of the primary payment method on a billing group. Used as a response field in:
payment_method_type
An alternate field name for the payment method type identifier.
Request (input) APIs:
Response (output) APIs:
pay_method_id
Returns the payment method type of the payment method originally used for a transaction. Used as a response field in:
pay_method_type_2
Returns the payment method type for a second payment method on the account, where supported. Used as a response field in:
Value Set Discrepancies
The valid values for payment method type fields differ across API methods based on context. The sections below identify the most significant discrepancies.
Values Available Only in Specific APIs
The following values do not appear in every API that uses a payment method type field.
| Value | Payment Method | APIs Where Available |
|---|---|---|
| -3 | Cash Credit | get_acct_payment_history_m (response only) |
| -2 | Internal Write-off | get_acct_payment_history_m (response only) |
| 21 | FIK | create_acct_complete_m, update_acct_complete_m, record_alternative_payment_m, get_acct_payment_history_m |
| 51 | Tokenized GooglePay | record_alternative_payment_m only |
APIs with Restricted Input Value Sets
When pay_method_type is used as a request input field, the valid values are a subset of the comprehensive reference. The following APIs accept only specific values.
create_acct_complete_m and update_acct_complete_m accept: 1, 2, 11, 13, 20, 21, 26, 37, 48, 53.
Note: While these APIs do accept deprecated payment methods without error, they are no longer actively supported by any functionality..
create_acct_billing_group_m and update_acct_billing_group_m accept: -1, 1, 2, 11, 13, 20, 26, 37, 48, 53. These APIs accept External Payment and legacy values but not FIK (21).
update_payment_method_m accepts a broader set that includes deprecated Net Terms values (4–7, 9, 12, 15–19) in addition to current values. If your integration uses Net Terms, use Payment Terms configuration instead of these deprecated values.
record_alternative_payment_m accepts only alternative payment processor values: 30, 32, 33, 34, 35, 36, 38, 39, 47, and 51. This API does not accept standard payment method types such as Credit Card (1) or ACH (2).
APIs With No Enumerated Values
The following APIs include a payment method type field in their response but do not enumerate a fixed set of valid values in the API specification. The field may return any value present in the system for that record.
- get_acct_billing_group_details_m (pay_method_type)
- get_acct_statement_all_m (payment_method_type)
- get_acct_surcharges_m (pay_method_type)
- get_payment_unapplication_details_m (payment_method_type)
Deprecated Values
- Net Terms: Several response APIs (including get_acct_payment_methods_and_terms_m and get_client_plan_service_rates_m) enumerate deprecated Net Terms values (4, 5, 6, 7, 9, 12, 15–19) as part of their defined value set. These values may appear in responses for accounts that were configured before Net Terms was replaced by Payment Terms. Do not submit these values as inputs in new integrations.
- Miscellaneous: 0—Other/None, 3—Pre-Paid, 8—Click&Buy, 10—PayByCash, 14—Purchase Power, 29—Reserve Account.