# Finix API Vocabulary

> Auto-generated from OpenAPI spec YAML files. Do not edit manually.
Last updated: 2026-02-20


| Field | Resources | Type | Description | JSON Paths |
|  --- | --- | --- | --- | --- |
| 3d_secure_authentication | authorizations, transfers | object | The 3D secure information required to create a 3D secure `Authorization.` | 3d_secure_authentication |
| 3ds_redirect_url | authorizations | string | The redirect URL used for 3DS transactions (if supported by the processor). | 3ds_redirect_url |
| accent_color | branding, checkout_forms, payment_links, ... | string | Hex code of the accent color. | branding.accent_color |
| accepted | onboarding_data, onboarding_forms | boolean | Whether the merchant accepted Amex marketing consent. | onboarding_data.additional_underwriting_data.amex_marketing_consent.accepted |
| account_number | onboarding_data, onboarding_forms, payment_instruments | string | The bank account number (no dashes in between numbers). Canadian bank account numbers cannot exceed 15 characters. | account_number, onboarding_data.payment_instruments.account_number |
| account_type | onboarding_data, onboarding_forms, payment_instruments | string | The type of bank account. Use the following respective enum when creating a `Payment Instrument` for: CHECKING: The checking account of your buyer. | account_type, onboarding_data.payment_instruments.account_type |
| account_updater_enabled | applications, payment_instruments | boolean | When enabled at the `Payment Instrument`-level, Finix automatically checks for updates with card networks. This Account Updater functionality: - Automatically updates card details (e.g., number or ... | account_updater_enabled |
| ach_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of an eCheck (also called ACH payments). Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | ach_basis_points |
| ach_basis_points_fee_limit | fee_profiles | integer | Maximum ACH basis points fee (in cents) incurred for each individual `Transfer`. | ach_basis_points_fee_limit |
| ach_credit_return_fixed_fee | fee_profiles | integer | A fixed amount (in cents) that will be charged to the seller for receiving an ACH Credit Return. | ach_credit_return_fixed_fee |
| ach_debit_return_fixed_fee | fee_profiles | integer | A fixed amount (in cents) that will be charged to the seller for receiving an ACH Debit Return. | ach_debit_return_fixed_fee |
| ach_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual `Transfer`. | ach_fixed_fee |
| ach_max_transaction_amount | onboarding_data, onboarding_forms | integer | Maximum ACH amount that can be transacted for a single transaction in cents (max 12 characters). Must be equal to or less than your `ach_max_transaction_amount`. | onboarding_data.ach_max_transaction_amount |
| ach_notice_of_change_credit_fixed_fee | fee_profiles | integer | The amount in cents charged as a fixed fee for processing ACH credit transactions that result in a Notice of Change (NOC). | ach_notice_of_change_credit_fixed_fee |
| ach_notice_of_change_debit_fixed_fee | fee_profiles | integer | Represents the fixed fee in cents for processing ACH debit transactions that generate a Notice of Change (NOC). | ach_notice_of_change_debit_fixed_fee |
| ach_rules | disbursement_rules | array[object] | List of configurations for ACH rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. | application_details.ach_rules, recipient_sender_rule_details.ach_rules |
| ach_velocity | disbursement_rules | object | An object that contains the current usage and limits for ACH disbursements. | ach_velocity |
| acquirer_reference_number | transfers | string | Unique identifier banks use to trace chargebacks or refunds. Available only for Mastercard transactions; otherwise returns `null`. | network_details.acquirer_reference_number |
| action | settlement_queue_entries, settlements | string | Specify the action to be performed on the `Settlement Queue Entry` resources. Use the `RELEASE` action to release a list of `Transfer`, `Fee`, or `Reversal` resources, placing them into a `Settleme... | action |
| additional_buyer_charges | amount_breakdown, amount_breakdown_level2_level3, amount_details, ... | object | Details about any Buyer Charges included in the `Transfer`. The buyer charges are mutually exclusive. | additional_buyer_charges, amount_breakdown.additional_buyer_charges, amount_breakdown_level2_level3.additional_buyer_charges, amount_details.amount_breakdown.additional_buyer_charges, receipt_options.amount_breakdown.additional_buyer_charges |
| additional_details | authorizations, checkout_forms, payment_links, ... | object | Object containing additional details. | additional_details, receipt_options.additional_details |
| additional_healthcare_data | authorizations, transfers | object | Object detailing any additional healthcare amounts included in the `Authorization`. Only non-healthcare merchant category codes (MCCs) are required to pass in additional healthcare data and have th... | additional_healthcare_data |
| additional_purchase_data | authorizations, transfers | object | Additional information about the purchase used for Level 2 and Level 3 Processing. Please note that Visa is ending its Level 2 offering in April 2026. | additional_purchase_data |
| additional_underwriting_data | identities, onboarding_data, onboarding_forms | object | Additional underwriting data about the user. | additional_underwriting_data, onboarding_data.additional_underwriting_data |
| address | payment_instruments | object | The address of the bank account owner. | address |
| address_verification | authorizations, payment_instruments, transfers | string | Details the results of the Address Verification checks. | address_verification |
| adjustment_request | transfers | boolean | Details if the `Transfer` was created to adjust funds. | adjustment_request |
| allow_custom_tip | device_configuration, devices, merchants | boolean | Allows the buyer to set a custom tip. `FINIX_V1` and `DUMMY_V1` only. | configuration.tipping_details.allow_custom_tip, device_configuration.tipping_details.allow_custom_tip |
| allow_debit | device_configuration, devices, merchants | boolean | Enable processing of transactions through Debit rails. If set to `false`, Debit card transactions will instead be processed through Credit rails. | configuration.allow_debit, device_configuration.allow_debit |
| allow_standalone_authorizations | device_configuration, devices, merchants | boolean | Sets whether the device allows initialization authorizations on its interface.`FINIX_V1` and `DUMMY_V1` only. | configuration.allow_standalone_authorizations, device_configuration.allow_standalone_authorizations |
| allow_standalone_refunds | device_configuration, devices, merchants | boolean | Sets whether the device allows initialization refunds on its interface. `FINIX_V1` and `DUMMY_V1` only. | configuration.allow_standalone_refunds, device_configuration.allow_standalone_refunds |
| allow_standalone_sales | device_configuration, devices, merchants | boolean | Sets whether the device allows initialization sales on its interface. | configuration.allow_standalone_sales, device_configuration.allow_standalone_sales |
| allowed_payment_methods | checkout_forms, payment_links, subscription_links | array[string] | The allowed payment methods. | allowed_payment_methods |
| allowed_payout_operations | payout_links | array[string] | Defines the types of operations permitted in the payout process when the recipient submits the payout form. | allowed_payout_operations |
| alternative_image_urls | image_details | array[string] | The locations of backup images if there is an issue with the primary image. | image_details.alternative_image_urls |
| american_express_assessment_basis_points | fee_profiles | integer | Applies to gross American Express card volume. | american_express_assessment_basis_points |
| american_express_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each American Express Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | american_express_basis_points |
| american_express_charge_dues_assessments | fee_profiles | integer | A fee associated with American Express's assessment of dues or ongoing charges for services provided through the American Express payment network. | american_express_charge_dues_assessments |
| american_express_charge_interchange | fee_profiles | integer | Set to `true` to incur interchange fees for American Express `Transfers`. | american_express_charge_interchange |
| american_express_externally_funded_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each American Express externally funded `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | american_express_externally_funded_basis_points |
| american_express_externally_funded_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual American Express externally funded `Transfer`. | american_express_externally_funded_fixed_fee |
| american_express_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual American Express `Transfer`. | american_express_fixed_fee |
| amex_marketing_consent | onboarding_data, onboarding_forms | object | Details about the merchant's consent to receive American Express marketing communications. | onboarding_data.additional_underwriting_data.amex_marketing_consent |
| amex_mid | entity, entity_buyer, identities, ... | integer | Assigned amexMid value. If a value is passed, it must be 10 or 11 digits. | entity.amex_mid, entity_buyer.amex_mid, onboarding_data.entity.amex_mid |
| amount | authorizations, balance_adjustments, balances, ... | integer (int64) | The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). | amount, subscription_details.amount, subscription_details.discount_phase_details.amount |
| amount_breakdown | amount_details, authorizations, checkout_forms, ... | object | The individual charges/fees that add up to the total amount. This field is required for the transaction to qualify for Level 2 or Level 3 processing. | amount_details.amount_breakdown, receipt_options.amount_breakdown |
| amount_details | checkout_forms, payment_links, payout_links | object | Object containing amount details. | amount_details |
| amount_requested | authorizations, transfer_attempts, transfers | integer | When `default_partial_authorization_enabled` is set to **true**, `amount_requested` indicates the amount the cardholder attempted to authorize. | amount_requested |
| amount_type | amount_details, checkout_forms, payment_links | string | The supported enums are: `FIXED` - A set amount that cannot be altered by the user. `VARIABLE` - Allows the user to set their own amount, provided it adheres to the minimum and maximum limits (`min... | amount_details.amount_type |
| ancillary_fixed_fee_primary | fee_profiles | integer | An additional fixed fee that can be charged per `Transfer`. | ancillary_fixed_fee_primary |
| ancillary_fixed_fee_secondary | fee_profiles | integer | An additional fixed fee that can be charged per `Transfer` if `ancillary_fixed_fee_primary` is included. | ancillary_fixed_fee_secondary |
| android_version | devices | string | The Android version installed on the `Device`. | android_version, system.android_version |
| annual_ach_volume | additional_underwriting_data, identities, onboarding_data, ... | integer | The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters). | additional_underwriting_data.annual_ach_volume, onboarding_data.additional_underwriting_data.annual_ach_volume |
| annual_card_volume | entity, entity_buyer, identities, ... | integer | The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters). | entity.annual_card_volume, entity_buyer.annual_card_volume, onboarding_data.entity.annual_card_volume |
| api_key | merchants | string |  | processor_details.api_key |
| application | application_profiles, authorizations, checkout_forms, ... | string | ID of the `Application` the resource was created under. | application |
| application_details | disbursement_rules | object | A container for rule configurations. | application_details |
| application_id | onboarding_forms, payment_instruments, payment_links, ... | string | ID of the `Application` the resource was created under. | application_id |
| application_identifier | authorizations, card_present_details, transfers | string | ID of the application used in the transaction. Tag 9F06 from the EMVCo standard. | card_present_details.emv_data.application_identifier |
| application_label | authorizations, card_present_details, transfers | string | EMV application label. Tag 50 from the EMVCo standard. | card_present_details.emv_data.application_label |
| application_preferred_name | authorizations, card_present_details, transfers | string | EMV application label with formatting (if provided). Tag 9F12 from the EMVCo standard. | card_present_details.emv_data.application_preferred_name |
| application_transaction_counter | authorizations, card_present_details, transfers | string | Transaction number for the EMV application. Tag 9F36 from the EMVCo standard. | card_present_details.emv_data.application_transaction_counter |
| approval_code | authorizations, card_present_details, transfers | string | Unique ID used to identify the approval of the `Transfer`. | card_present_details.approval_code |
| associated_entities | onboarding_data, onboarding_forms | array[object] | The `entities` saved in the `associated_identities` of the user. For more information, see Create an Associated Identity. | onboarding_data.associated_entities |
| associated_files | onboarding_data, onboarding_forms | array[object] | List of Files your user uploaded inside their Onboarding Form. | onboarding_data.associated_files |
| attempt_bank_account_validation_check | onboarding_data, onboarding_forms, payment_instruments | object | Verify and validate the `Payment Instrument` to ensure it is suitable for ACH Direct Debits. Set to `true` to confirm that the `Payment Instrument` can be used for ACH payments. | attempt_bank_account_validation_check, onboarding_data.payment_instruments.attempt_bank_account_validation_check |
| attempt_level_two_level_three_payment | checkout_forms, payment_links | boolean | Setting this field to true enables Level 2/Level 3 data collection for card payments. | attempt_level_two_level_three_payment |
| authentication | webhooks | object | The authentication settings that are used to send webhook events. | authentication |
| authorization_code | transfers | string | Code returned by the issuing bank when a transaction is authorized. | network_details.authorization_code |
| authorization_id | transfer_attempts | string | The `Authorization` associated with the `Transfer Attempt`, if applicable. | authorization_id |
| available_amount | balances | integer | The amount of funds that are currently safe to use or withdraw. This balance reflects settled funds minus any initiated outflows (such as payouts) that reduce availability immediately, even if they... | available_amount |
| available_storage_megabytes | devices | integer | The storage space remaining on the device in megabtypes. | system.available_storage_megabytes |
| average_ach_transfer_amount | additional_underwriting_data, identities, onboarding_data, ... | integer | The approximate average ACH sale amount (in cents) for this merchant. | additional_underwriting_data.average_ach_transfer_amount, onboarding_data.additional_underwriting_data.average_ach_transfer_amount |
| average_card_transfer_amount | additional_underwriting_data, identities, onboarding_data, ... | integer | The average credit card sale amount (in cents) for this merchant. | additional_underwriting_data.average_card_transfer_amount, onboarding_data.additional_underwriting_data.average_card_transfer_amount |
| balance_adjustment_rules | disbursement_rules | array[object] | List of configurations for balance adjustment rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. | application_details.balance_adjustment_rules, recipient_sender_rule_details.balance_adjustment_rules |
| balance_adjustment_velocity | disbursement_rules | object | An object that contains the current usage and limits for balance adjustments. | balance_adjustment_velocity |
| balance_entry_id | balance_adjustments | string | A ledger record that tracks individual financial movements within a `Balance Adjustment`. | balance_entry_id |
| bank_account_validation_check | payment_instruments | string | Possible values returned when `attempt_bank_account_validation_check` is `true` or the `Payment Instrument` is used for a `Transfer`: - `INCONCLUSIVE`: A verification check was conducted, but the b... | bank_account_validation_check |
| bank_code | onboarding_data, onboarding_forms, payment_instruments | string | The routing number of the bank account. | bank_code, onboarding_data.payment_instruments.bank_code |
| bank_return_details | transfers | object | Details about a transfer that was returned and was unable to be processed. Only present when `state` is `RETURNED` | bank_return_details |
| basic | webhooks | object | The basic authentication configuration. It is null if basic authentication is not used. | authentication.basic |
| basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each card-based `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | basis_points |
| battery_level_percent | devices | integer | The device's battery level percentage. | power.battery_level_percent |
| battery_temperature_celsius | devices | number (double) | The battery temperature measured in Celsius. | power.battery_temperature_celsius |
| battery_temperature_fahrenheit | devices | number (double) | The battery temperature measured in Fahrenheit. | power.battery_temperature_fahrenheit |
| bearer | webhooks | object | The bearer authentication configuration. | authentication.bearer |
| billing_address | buyer_details, checkout_forms, transfer_attempts | object | The primary address associated with the `Payment Instrument`. | buyer_details.billing_address |
| billing_currency | verifications | string | This object is not applicable to merchant verification. | payment_instrument_verification_details.billing_currency |
| billing_interval | subscription_links, subscriptions | string | How often the buyer is billed. | billing_interval, subscription_details.billing_interval |
| billing_interval_count | subscription_links, subscriptions | integer | The number of billing intervals the discount applies. After this period, the buyer is charged the full `amount` from the `Subscription`. | subscription_details.discount_details.billing_interval_count, subscription_details.discount_phase_details.billing_interval_count, subscription_details.subscription_details.discount_details.billing_interval_count |
| bin | payment_instruments | string | The Bank Identification Number for the `Payment Instrument`. | bin, new_instrument_details.bin, old_instrument_details.bin |
| brand | authorizations, card_present_details, payment_instruments, ... | string | The brand of the card saved in the `Payment Instrument`. | brand, card_present_details.brand, network_details.brand, new_instrument_details.brand, old_instrument_details.brand |
| brand_color | branding, checkout_forms, payment_links, ... | string | Hex code of branding color. | branding.brand_color |
| branding | checkout_forms, payment_links, payout_links, ... | object | Branding settings for the `Subscription Link`. | branding |
| business_address | applications, entity, entity_buyer, ... | object | The primary address for the legal entity. | entity.business_address, entity_buyer.business_address, onboarding_data.entity.business_address, recipient_details.business_address |
| business_description | additional_underwriting_data, identities, onboarding_data, ... | string | Description of this merchant's business (max 200 characters). | additional_underwriting_data.business_description, onboarding_data.additional_underwriting_data.business_description |
| business_name | applications, entity, entity_buyer, ... | string | The merchant's legal business name (max 120 characters). If INDIVIDUAL_SOLE_PROPRIETORSHIP , pass the owner's legal first name, last name, and middle initial. | entity.business_name, entity_buyer.business_name, onboarding_data.entity.business_name, recipient_details.business_name |
| business_phone | applications, entity, entity_buyer, ... | string | Customer service phone number where the merchant can be reached (max 10 characters). | entity.business_phone, entity_buyer.business_phone, onboarding_data.entity.business_phone |
| business_tax_id | applications, entity, entity_buyer, ... | string | Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL_SOLE_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor... | entity.business_tax_id, entity_buyer.business_tax_id, onboarding_data.entity.business_tax_id |
| business_tax_id_provided | onboarding_data, onboarding_forms, transfer_attempts | boolean | Details if the `business_tax_id` was provided. | onboarding_data.entity.business_tax_id_provided, recipient_details.business_tax_id_provided |
| business_to_business_volume_percentage | additional_underwriting_data, identities, onboarding_data, ... | integer | The percentage of the merchant's volume that's business to business (between 0 and 100). | additional_underwriting_data.volume_distribution_by_business_type.business_to_business_volume_percentage, onboarding_data.additional_underwriting_data.volume_distribution_by_business_type.business_to_business_volume_percentage |
| business_to_consumer_volume_percentage | additional_underwriting_data, identities, onboarding_data, ... | integer | The percentage of the merchant's volume that's business to consumer (between 0 and 100). | additional_underwriting_data.volume_distribution_by_business_type.business_to_consumer_volume_percentage, onboarding_data.additional_underwriting_data.volume_distribution_by_business_type.business_to_consumer_volume_percentage |
| business_type | applications, entity, entity_buyer, ... | string | Include the value that best applies to the merchant. | entity.business_type, entity_buyer.business_type, onboarding_data.entity.business_type |
| button_font_color | branding, checkout_forms, payment_links, ... | string | Hex code of the button font color. | branding.button_font_color |
| button_label | subscription_links | string | The text that displays within the button. | branding.button_label |
| buyer_details | checkout_forms, payment_links, subscription_links, ... | object | Object containing details about the user. This object is only valid when `payment_frequency` is `ONE_TIME`. | buyer_details, subscription_details.buyer_details |
| bypass_device_on_capture | device_configuration, devices, merchants | boolean | Sets whether or not the device will be used to capture transactions. This field should be set to `true` unless there are special circumstances. | configuration.bypass_device_on_capture, device_configuration.bypass_device_on_capture |
| canceled_via | subscriptions | string | If the subscription was canceled, this field shows how the cancellation was initiated. Possible values: - `MERCHANT` - The customer (merchant) canceled the subscription themselves. | canceled_via |
| capture_amount | authorizations | integer (int64) | The amount of the `Authorization` you would like to capture in cents. Must be less than or equal to the `amount` of the `Authorization`. | capture_amount |
| card_cross_border_basis_points | fee_profiles | integer | Percentage-based fee charged against the full amount of every `Transfer` that includes non-US cards. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | card_cross_border_basis_points |
| card_cross_border_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual American Express `Transfer`. | card_cross_border_fixed_fee |
| card_cvv_required | merchants | boolean | Set to `true` to require the card's CVV code. | card_cvv_required |
| card_expiration_date_required | merchants | boolean | Set to `true` to require the card's expiration date. | card_expiration_date_required |
| card_network_details | merchants | object |  | card_network_details |
| card_present_details | authorizations, transfers | object | Details needed to process card present transactions. | card_present_details |
| card_present_fee_profile | application_profiles | string | The ID of the `Fee Profile` used for all card present transfers associated with the `Merchant Profile` resource. If not set, the value in `fee_profile` will be used for card present transfers. | card_present_fee_profile |
| card_present_percentage | additional_underwriting_data, identities, onboarding_data, ... | integer | The percentage of the merchant's volume that's card present (between 0 and 100). | additional_underwriting_data.card_volume_distribution.card_present_percentage, onboarding_data.additional_underwriting_data.card_volume_distribution.card_present_percentage |
| card_rules | disbursement_rules | array[object] | List of configurations for card rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule. | application_details.card_rules, recipient_sender_rule_details.card_rules |
| card_type | payment_instruments, verifications | string | The type of payment card saved in the `Payment Instrument`. | card_type, payment_instrument_verification_details.card_type |
| card_velocity | disbursement_rules | object | An object that contains the current usage and limits for Card disbursements. | card_velocity |
| card_volume_distribution | additional_underwriting_data, identities, onboarding_data, ... | object | The distribution of the merchant's credit card volume The sum of `card_volume_distribution` must be 100. | additional_underwriting_data.card_volume_distribution, onboarding_data.additional_underwriting_data.card_volume_distribution |
| cardholder_authentication | 3d_secure_authentication, authorizations, transfers | string | Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction and is sometimes referred to as the c... | 3d_secure_authentication.cardholder_authentication |
| cart_return_url | checkout_forms | string | URL to redirect the user back to their cart. | additional_details.cart_return_url |
| category | fees | string | The `Fee` category. | category |
| charge_dues_assessments | fee_profiles | boolean | Whether to pass the dues and assessment fees levied by all applicable card brands (e.g., American Express, Discover, Visa, Mastercard). | charge_dues_assessments |
| charge_interchange | fee_profiles | boolean | Set to **True** to incur interchange fees for card-based `Transfers`. | charge_interchange |
| check_for_duplicate_transactions | device_configuration, devices, merchants | boolean | Sets if the device will check for duplicate transactions. `DATACAP_V1` only. | configuration.check_for_duplicate_transactions, device_configuration.check_for_duplicate_transactions |
| city | address, applications, authorizations, ... | string | City (max 20 characters). | address.city, buyer_details.billing_address.city, buyer_details.shipping_address.city, entity.business_address.city, entity.personal_address.city, entity_buyer.business_address.city, entity_buyer.personal_address.city, ip_address_details.ipv4.estimated_location.city, onboarding_data.entity.business_address.city, onboarding_data.entity.personal_address.city, recipient_details.business_address.city, recipient_details.personal_address.city, subscription_details.buyer_details.shipping_address.city |
| clinic_amount | additional_healthcare_data, authorizations, transfers | integer | A clinic or other qualified medical amount for the transaction. | additional_healthcare_data.clinic_amount |
| collect_billing_address | additional_details, subscription_links | boolean | The collected billing address. | additional_details.collect_billing_address |
| collect_email | additional_details, subscription_links | boolean | The collected email address. | additional_details.collect_email |
| collect_name | additional_details, subscription_links | boolean | The collected user's name. | additional_details.collect_name |
| collect_phone | checkout_forms, payment_links, subscription_links | boolean | The collected phone number. | additional_details.collect_phone |
| collect_shipping_address | additional_details, subscription_links | boolean | The collected shipping address. | additional_details.collect_shipping_address |
| collection_method | subscription_links, subscriptions | string | The method by which subscription payments are collected. At this time, only `BILL_AUTOMATICALLY` is supported. | subscription_details.collection_method, subscription_details.subscription_details.collection_method |
| compliance_form_template | compliance_forms | string | The ID of the template used to create the `Compliance Form`. | compliance_form_template |
| compliance_forms_overdue_fixed_fee | fee_profiles | integer | Fee in cents charged for an overdue compliance form. | compliance_forms_overdue_fixed_fee |
| configuration | devices, merchants | object | Information used to configure how the `Device` handles transaction flows. | configuration |
| connection | devices | string | Whether the device is available to communicate with Finix Server. | connection |
| connectivity | devices | object | `Device` connection details. | connectivity |
| consumer_to_consumer_volume_percentage | additional_underwriting_data, identities, onboarding_data, ... | integer | Merchant's percentage of volume that is consumer to consumer (between 0 and 100). | additional_underwriting_data.volume_distribution_by_business_type.consumer_to_consumer_volume_percentage, onboarding_data.additional_underwriting_data.volume_distribution_by_business_type.consumer_to_consumer_volume_percentage |
| convenience_amount | additional_buyer_charges, amount_breakdown, amount_breakdown_level2_level3, ... | integer | A convenience fee to charge the buyer for the transaction. This object property is mutually exclusive. | additional_buyer_charges.convenience_amount, amount_breakdown.additional_buyer_charges.convenience_amount, amount_breakdown_level2_level3.additional_buyer_charges.convenience_amount, amount_details.amount_breakdown.additional_buyer_charges.convenience_amount, receipt_options.amount_breakdown.additional_buyer_charges.convenience_amount |
| convenience_charges_enabled | merchants | boolean | Set to `true` if you want to enable the `Merchant` to accept convenience fees and/or service fees. | convenience_charges_enabled |
| count_limit | disbursement_rules | integer | The count limit for disbursements. | ach_velocity.daily_velocity.count_limit, rule.count_limit, velocity.count_limit |
| country | address, applications, authorizations, ... | string | 3-Letter Country code (e.g. USA). | address.country, buyer_details.billing_address.country, buyer_details.shipping_address.country, country, entity.business_address.country, entity.personal_address.country, entity_buyer.business_address.country, entity_buyer.personal_address.country, ip_address_details.ipv4.estimated_location.country, onboarding_data.country, onboarding_data.entity.business_address.country, onboarding_data.entity.personal_address.country, onboarding_data.payment_instruments.country, recipient_details.business_address.country, recipient_details.personal_address.country, subscription_details.buyer_details.shipping_address.country |
| created_at | application_profiles, authorizations, balance_adjustments, ... | string (date-time) | Timestamp of when the object was created. | created_at |
| created_by | balances, users | string | The ID of the application user that created this `Balance Adjustment`. | created_by |
| created_via | payment_instruments | string | The method by which the resource was created. | created_via |
| creating_transfer_from_report_enabled | merchants | boolean | Set to `true` to automatically create `Transfers` once settlement reports get generated. | creating_transfer_from_report_enabled |
| credential_on_file | authorizations, transfers | object | An object that contains information about the credential on file transfer. - `type`: The type of credential on file transfer. | credential_on_file |
| credit_check_allowed | additional_underwriting_data, identities | boolean | Sets if this merchant has consented and accepted to a credit check. | additional_underwriting_data.credit_check_allowed |
| credit_check_ip_address | additional_underwriting_data, identities | string | The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.112 ). | additional_underwriting_data.credit_check_ip_address |
| credit_check_timestamp | additional_underwriting_data, identities, onboarding_data, ... | string | A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z). | additional_underwriting_data.credit_check_timestamp, onboarding_data.additional_underwriting_data.credit_check_timestamp |
| credit_check_user_agent | additional_underwriting_data, identities, onboarding_data, ... | string | The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)). | additional_underwriting_data.credit_check_user_agent, onboarding_data.additional_underwriting_data.credit_check_user_agent |
| cryptogram | authorizations, card_present_details, transfers | string | Cryptogram returned by the card. Tag 9F26 of the EMVCo standard. | card_present_details.emv_data.cryptogram |
| currencies | merchants | array[object] | ISO 4217 3-letter currency code. | currencies |
| currency | amount_details, authorizations, balance_adjustments, ... | string | ISO 4217 3-letter currency code. | amount_details.currency, currency, daily_rule_configuration.currency, maximum_transaction_amount.currency, monthly_rule_configuration.currency, onboarding_data.payment_instruments.currency, rule_configuration.currency, subscription_details.currency |
| current_count | disbursement_rules | integer | The current count of disbursements. | ach_velocity.daily_velocity.current_count, velocity.current_count |
| current_volume | disbursement_rules | integer | The current volume of disbursements. | ach_velocity.daily_velocity.current_volume, velocity.current_volume |
| customer_reference_number | additional_purchase_data, authorizations, buyer_details, ... | string | The customer reference for the purchase (max 17 characters). For Visa, this field no longer qualifies for lower interchange after April 17, 2026. | additional_purchase_data.customer_reference_number, buyer_details.customer_reference_number |
| customs_duty_amount | additional_purchase_data, amount_breakdown_level2_level3, amount_details, ... | integer | The duty in cents on the total purchase amount for the order. | additional_purchase_data.customs_duty_amount, amount_breakdown_level2_level3.customs_duty_amount, amount_details.amount_breakdown.customs_duty_amount |
| daily_velocity | disbursement_rules | object | An object that contains the current usage and limits for disbursements. | ach_velocity.daily_velocity, balance_adjustment_velocity.daily_velocity, card_velocity.daily_velocity |
| day | additional_purchase_data, applications, authorizations, ... | integer | Day of purchase (between 1 and 31). | additional_purchase_data.order_date.day, entity.dob.day, entity.incorporation_date.day, entity_buyer.dob.day, entity_buyer.incorporation_date.day, next_billing_date.day, onboarding_data.entity.dob.day, onboarding_data.entity.incorporation_date.day, rule.day |
| default_partial_authorization_enabled | identities, merchants | boolean | - Set to **true** if you want to enable partial authorizations for a specific `Merchant`. - Partial authorizations enable the `Merchant` to collect a portion of the amount if the cardholder doesn't... | default_partial_authorization_enabled |
| default_statement_descriptor | applications, entity, entity_buyer, ... | string | The description of the `Merchant` that appears on the buyer's bank or card statement. | entity.default_statement_descriptor, entity_buyer.default_statement_descriptor, onboarding_data.entity.default_statement_descriptor |
| dental_amount | additional_healthcare_data, authorizations, transfers | integer | The dental amount for the transaction. | additional_healthcare_data.dental_amount |
| description | balance_adjustments, balances, devices, ... | string | A description of the `Balance Adjustment`. | description, termination_details.description |
| destination | payment_links, settlements, transfers | string | The delivery attempt destination. | destination |
| destination_country_code | additional_purchase_data, authorizations, transfers | string | The ISO country code of the order destination. | additional_purchase_data.destination_country_code |
| destination_postal_code | additional_purchase_data, authorizations, transfers | string | The postal code of the order destination (10 characters). | additional_purchase_data.destination_postal_code |
| device | authorizations, transfers | string | The ID of the activated device. | device |
| device_id | devices | string | The device from which the metrics were collected. | device_id |
| diners_club_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each Diners `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | diners_club_basis_points |
| diners_club_charge_interchange | fee_profiles | boolean | Set to `true` to incur interchange fees for Diners `Transfers`. | diners_club_charge_interchange |
| diners_club_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual Diners `Transfer`. | diners_club_fixed_fee |
| disabled_code | payment_instruments | string |  | disabled_code |
| disabled_message | payment_instruments | string |  | disabled_message |
| disbursements_same_day_ach_pull_enabled | merchants | boolean | Indicates whether same-day ACH pull disbursements (debits) are enabled, allowing funds to be withdrawn from an account via same-day ACH transfer. | disbursements_same_day_ach_pull_enabled |
| disbursements_same_day_ach_push_enabled | merchants | boolean | Indicates whether same-day ACH push disbursements (credits) are enabled, allowing funds to be sent to an account via same-day ACH transfer. | disbursements_same_day_ach_push_enabled |
| discount_amount | additional_purchase_data, amount_breakdown, amount_breakdown_level2_level3, ... | integer | The amount in cents of the discount for the order. You must include this field to qualify for Level 3 interchange benefits. | additional_purchase_data.discount_amount, amount_breakdown.discount_amount, amount_breakdown_level2_level3.discount_amount, amount_details.amount_breakdown.discount_amount, receipt_options.amount_breakdown.discount_amount |
| discount_details | subscription_links, subscriptions | object | Object containing discount details. | subscription_details.discount_details, subscription_details.subscription_details.discount_details |
| discount_phase_details | subscriptions | object | Object containing discount phase details. | subscription_details.discount_phase_details |
| discount_phase_expected_end_at | subscriptions | string (date-time) | A timestamp indicating when the discount phase is expected to end. | subscription_details.discount_phase_details.discount_phase_expected_end_at |
| discount_phase_expected_start_at | subscriptions | string (date-time) | A timestamp indicating when the discount phase is expected to start. | subscription_details.discount_phase_details.discount_phase_expected_start_at |
| discount_phase_started_at | subscriptions | string (date-time) | A timestamp indicating when the discount phase began. | subscription_details.discount_phase_details.discount_phase_started_at |
| discover_assessments_basis_points | fee_profiles | integer | An assessment that applies to gross Discover card transaction volume. | discover_assessments_basis_points |
| discover_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each Discover Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | discover_basis_points |
| discover_charge_dues_assessments | fee_profiles | integer | A fee associated with Discover's assessment of dues or ongoing charges for services provided through the Discover payment network. | discover_charge_dues_assessments |
| discover_charge_interchange | fee_profiles | integer | Set to `true` to incur interchange fees for Discover `Transfers`. | discover_charge_interchange |
| discover_data_usage_fixed_fee | fee_profiles | integer | Applies to all U.S.-based authorization transactions. | discover_data_usage_fixed_fee |
| discover_externally_funded_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each Discover externally funded `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | discover_externally_funded_basis_points |
| discover_externally_funded_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual Discover externally funded `Transfer`. | discover_externally_funded_fixed_fee |
| discover_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual Discover `Transfer`. | discover_fixed_fee |
| discover_mid | entity, entity_buyer, identities, ... | integer | Assigned discoverMid value. | entity.discover_mid, entity_buyer.discover_mid, onboarding_data.entity.discover_mid |
| discover_network_authorization_fixed_fee | fee_profiles | integer | This fee will apply to all Discover network authorizations and will replace the previously assessed Data Transmission. | discover_network_authorization_fixed_fee |
| display_name | fees, files, payment_instruments | string | It is used for subscription fees and allows free-form text to be passed from the subscription fee product. Note that this product is mostly deprecated. | display_name |
| display_tip_on_receipt | device_configuration, devices, merchants | boolean | Sets whether the device will display the blank tip amount on the receipt for authorizations to be later captured. `FINIX_V1` and `DUMMY_V1` only. | configuration.display_tip_on_receipt, device_configuration.display_tip_on_receipt |
| dispute_fixed_fee | fee_profiles | integer | Fee applied when a `Dispute` is created or updated to a `PENDING` state. | dispute_fixed_fee |
| dispute_inquiry_fixed_fee | fee_profiles | integer | Fee applied when a `Dispute` is created or updated to a `PENDING` state. | dispute_inquiry_fixed_fee |
| dob | applications, entity, entity_buyer, ... | object | The control owner's date of birth. | entity.dob, entity_buyer.dob, onboarding_data.entity.dob |
| doing_business_as | applications, entity, entity_buyer, ... | string | Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters). | entity.doing_business_as, entity_buyer.doing_business_as, onboarding_data.entity.doing_business_as, recipient_details.doing_business_as |
| domain | payment_instruments | string | The domain (or website) where the buyer is initiating the payment. | domain |
| due_at | compliance_forms | string (date-time) | Timestamp of when the `Compliance Form` is due. By default, this is 3 months after the form was created. | due_at |
| duration | files | integer | Details how long (in minutes) the `url` is valid for. | duration |
| ecommerce_percentage | additional_underwriting_data, identities, onboarding_data, ... | integer | The percentage of the merchant's business that is eCommerce (between 0 and 100). | additional_underwriting_data.card_volume_distribution.ecommerce_percentage, onboarding_data.additional_underwriting_data.card_volume_distribution.ecommerce_percentage |
| eft_basis_points | fee_profiles | integer | The percentage-based fee applied to the total amount of an EFT sale. Measured in basis points, where 1 basis point equals 0.01% (e.g., 100 basis points = 1%). | eft_basis_points |
| eft_basis_points_fee_limit | fee_profiles | integer | The maximum percentage-based fee (in cents) incurred for each individual `Transfer`. | eft_basis_points_fee_limit |
| eft_credit_return_fixed_fee | fee_profiles | integer | A fixed fee (in cents) charged to the merchant for processing an EFT credit return. | eft_credit_return_fixed_fee |
| eft_debit_return_fixed_fee | fee_profiles | integer | A fixed fee (in cents) charged to the seller for processing an EFT debit return. | eft_debit_return_fixed_fee |
| eft_fixed_fee | fee_profiles | integer | A flat fee (in cents) incurred for each individual `Transfer` made from an EFT sale. | eft_fixed_fee |
| electronic_commerce_indicator | 3d_secure_authentication, authorizations, transfers | string | - **AUTHENTICATED**: Approved by 3D Secure Vendor. - **ATTEMPTED**: Issuer or cardholder does not support 3D Secure. | 3d_secure_authentication.electronic_commerce_indicator |
| email | applications, buyer_details, checkout_forms, ... | string | Email address of the buyer. | buyer_details.email, email, entity.email, entity_buyer.email, onboarding_data.entity.email, recipient_details.email |
| emv_data | authorizations, card_present_details, transfers | object | Encrypted card data used to process the transaction. | card_present_details.emv_data |
| enabled | devices, disbursement_rules, payment_instruments, ... | boolean | Whether the `Device` is enabled. `false` indicates disabled. | enabled, rule.enabled |
| enabled_events | webhooks | array[array] | A list of events the webhook is explicitly enabled for. | enabled_events |
| entity | applications, identities, onboarding_data, ... | object | Information needed to verify the identity of the entity. | entity, onboarding_data.entity |
| entity_details | settlements | object | An object containing additional details about the entity. | entity_details |
| entity_id | balances, payment_links, settlement_queue_entries, ... | string | The ID of the resource that caused the change to the `Balance`, either a `Balance Adjustment` (i.e., "top-up") or a `Transfer`. | entity_id |
| entity_type | balances, payment_links, settlement_queue_entries, ... | string | The resource type that caused the change to the `Balance`. | entity_type |
| entry_mode | authorizations, card_present_details, transfers | string | Details of the card payment method used to process the transaction. The possible enums are: - UNKNOWN - The method by which the payment card was used is unknown. | card_present_details.entry_mode |
| estimated_location | authorizations, ip_address_details, transfers | object |  | ip_address_details.ipv4.estimated_location |
| estimated_posted_date | balances | string (date-time) | Timestamp estimating when the `Balance Entry` will be posted (i.e., the `state` is set to `SUCCEEDED`). | estimated_posted_date |
| estimated_tax_amount | amount_breakdown, amount_breakdown_level2_level3, amount_details, ... | integer | The estimated amount of tax applied to the order. This field is optional for Level 2 processing. | amount_breakdown.estimated_tax_amount, amount_breakdown_level2_level3.estimated_tax_amount, amount_details.amount_breakdown.estimated_tax_amount, receipt_options.amount_breakdown.estimated_tax_amount |
| event_type | devices | string | The type of event that triggered the generation of the `Device Metric` log. | event_type |
| expiration_in_minutes | additional_details, additional_details_payout, onboarding_forms, ... | integer | How long (in minutes) the link should be valid for. Defaults to 60 minutes. | additional_details.expiration_in_minutes, additional_details_payout.expiration_in_minutes, onboarding_link_details.expiration_in_minutes |
| expiration_month | payment_instruments | integer | The expiration month of the card (e.g., `12` for December). | expiration_month, new_instrument_details.expiration_month, old_instrument_details.expiration_month |
| expiration_year | payment_instruments | integer | The 4-digit expiration year of the card. | expiration_year, new_instrument_details.expiration_year, old_instrument_details.expiration_year |
| expired | files | boolean | Whether the external link has expired. | expired |
| expired_session_url | additional_details, additional_details_payout, onboarding_forms, ... | string | The URL users get sent to if the bearer token expires. | additional_details.expired_session_url, additional_details_payout.expired_session_url, onboarding_link_details.expired_session_url |
| expires_at | authorizations, files, onboarding_forms, ... | string (date-time) | `Authorization` expiration time. | expires_at, onboarding_link.expires_at |
| extension | files | string | The extension of the file. | extension |
| external_reference_number | balances | string | External reference number for the wire transfer. | wire_details.external_reference_number |
| externally_funded | transfers | string | Details if the `Transfer` will be settled externally by card processors. | externally_funded |
| externally_funded_basis_points | fee_profiles | integer | The percentage-based fee applied to the total amount of each externally funded `Transfer`. Measured in basis points, where 1 basis point equals 0.01%. | externally_funded_basis_points |
| externally_funded_fixed_fee | fee_profiles | integer | A fixed fee (in cents) incurred for each individual externally funded `Transfer`. | externally_funded_fixed_fee |
| failure_code | authorizations, balance_adjustments, settlements, ... | string | The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see Failure Codes. | failure_code |
| failure_message | authorizations, balance_adjustments, settlements, ... | string | A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment. | failure_message |
| fast_funds_indicator | payment_instruments | string | Details if Fast Funds is enabled for the card. | fast_funds_indicator |
| fee | authorizations, split_transfers, transfers | integer (int64) | The minimum amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`). | fee |
| fee_category | settlements | string | The category of the fee. | entity_details.fee_category |
| fee_details_url | onboarding_forms, onboarding_link_details | string | The URL of the page where you display the fees related to processing payments (for more info, see Onboarding Forms). | onboarding_link_details.fee_details_url |
| fee_profile | application_profiles, fees, transfers | string | The ID of the `Fee Profile` associated with the `Application`. | fee_profile |
| fee_profile_id | split_transfers | string | The `Fee Profile` associated to this `Split Transfer`. | fee_profile_id |
| fee_ready_to_settle_upon | merchants | string | Details how the `Merchant` settles fees. | fee_ready_to_settle_upon |
| fee_subtype | fees | string | The subtype of the `Fee`. | fee_subtype |
| fee_type | fees, transfers | string | The type of `Fee`. Finix may return more enums than those provided. | fee_type |
| file | files | string | Path to the file to upload. | file |
| file_id | files | string | The `File` ID the `External Link` relates to. | file_id |
| file_name | files | string | The name of the uploaded `File`. It is `null` when the `File` resource is first created and is automatically updated to the uploaded file's name. | file_name |
| files | compliance_forms | object | IDs of the `File` resources for the signed and unsigned `Compliance Form` PDFs. | files |
| fingerprint | payment_instruments | string | Unique ID that represents the tokenized card data. | fingerprint, new_instrument_details.fingerprint, old_instrument_details.fingerprint |
| firmware_version | devices | string | The current version of the device's firmware. | firmware_version, system.firmware_version |
| first_approved_at | merchants | string (date-time) | This field shows the timestamp when the `Merchant` was first approved. If the `Merchant` has not been approved yet, the value is `null`. | first_approved_at |
| first_charge_at | subscriptions | string (date-time) | Timestamp when the first `Transfer` will occur. | first_charge_at |
| first_name | applications, buyer_details, checkout_forms, ... | string | First name of the buyer. | buyer_details.first_name, entity.first_name, entity_buyer.first_name, first_name, onboarding_data.entity.first_name, recipient_details.first_name |
| fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual card-based `Transfer`. | fixed_fee |
| fixed_options | device_configuration, devices, merchants | array[object] | Sets the fixed amount that will be displayed on the terminal. Defaults to `[100, 150, 200]`. | configuration.tipping_details.fixed_options, device_configuration.tipping_details.fixed_options |
| fraud_session_id | authorizations, transfers | string | The session ID you want to review for fraud. For more info, see Fraud Detection. | fraud_session_id |
| funding_transfer_id | settlements | string | The ID of the `Transfer` used to track the payout. | funding_transfer_id |
| funds_flow | settlements | string | Details how funds will be dispersed in the `Funding Transfer` (usually `null`). | funds_flow |
| gateway | identities, merchants | string | Name of the gateway that routes the `Merchant's` transactions to the processor. | gateway |
| gross_monthly_fees_ach_basis_points | fee_profiles | integer | The total amount of ACH (eCheck) basis point fees charged over a month. | gross_monthly_fees_ach_basis_points |
| gross_monthly_fees_ach_fixed_fee | fee_profiles | integer | The total amount of ACH (eCheck) fixed fees charged over a month. | gross_monthly_fees_ach_fixed_fee |
| gross_monthly_fees_card_basis_points | fee_profiles | integer | The total amount of card basis point fees charged over a month. | gross_monthly_fees_card_basis_points |
| gross_monthly_fees_card_fixed_fee | fee_profiles | integer | The total amount of card fixed fees charged over a month. | gross_monthly_fees_card_fixed_fee |
| gross_monthly_fees_eft_basis_points | fee_profiles | integer | The total amount of EFT basis point fees charged over a month. | gross_monthly_fees_eft_basis_points |
| gross_monthly_fees_eft_fixed_fee | fee_profiles | integer | The total amount of EFT fixed fees charged over a month. | gross_monthly_fees_eft_fixed_fee |
| gross_settlement_enabled | merchants | boolean | Set to `true` to enable gross settlements. | gross_settlement_enabled |
| has_accepted_credit_cards_previously | entity, entity_buyer, identities, ... | boolean | Defaults to **false** if not passed. | entity.has_accepted_credit_cards_previously, entity_buyer.has_accepted_credit_cards_previously, onboarding_data.entity.has_accepted_credit_cards_previously |
| icon | branding, checkout_forms, payment_links, ... | string | URL for the icon of the payment link. | branding.icon |
| id | application_profiles, authorizations, balance_adjustments, ... | string | The ID of the resource. | id |
| idempotency_id | authorizations, transfers | string | Pass any randomly generated or internal ID to idempotently identify `Transfers`, `Authorizations`, or refund requests. | idempotency_id |
| identity | authorizations, merchants, payment_instruments, ... | string | ID of the buyer 'Identity' to run the card present authorization. Finix tokenizes the card associated with the provided 'Identity' and processes the authorization, removing the need to create a bla... | identity |
| identity_id | buyer_details, checkout_forms, files, ... | string | The `Identity` `id` of the buyer. | buyer_details.identity_id, identity_id, subscription_details.buyer_details.identity_id |
| identity_roles | identities | array[string] | The set of roles available to the `Identity`. If none is provided, the Identity will be assigned `BUYER`. | identity_roles |
| idle_image_file_id | device_configuration, devices, merchants | string | The ID of the file to be displayed on the device when it is idle. Passing a value of `null` resets the device's idle image to the default. | configuration.idle_image_file_id, device_configuration.idle_image_file_id, idle_image_file_id |
| idle_message | device_configuration, devices, merchants | string | Sets the idle message text on the terminal. This is what will be presented on the welcome screen. | configuration.idle_message, device_configuration.idle_message, idle_message |
| ids | settlement_queue_entries | array[string] | An array of IDs representing the `Settlement Queue Entry` resources on which to apply the specified `action`. | ids |
| incorporation_date | entity, entity_buyer, identities, ... | object | The date the company was founded and registered. | entity.incorporation_date, entity_buyer.incorporation_date, onboarding_data.entity.incorporation_date |
| initial_transfer_id | authorizations, transfers | string | The ID of the initial transfer in the series. | credential_on_file.initial_transfer_id |
| instant_payouts_card_push_enabled | merchants | boolean | Set to `true` if you want to allow the merchant to be enabled for settlement instant payouts. | instant_payouts_card_push_enabled |
| institution_number | payment_instruments | string | Canadian bank identifier (EFT). Exactly 3 digits that identify the financial institution (e.g., 004 = TD, 002 = Scotiabank). | institution_number |
| instrument_id | balance_adjustments, settlements, subscription_links, ... | string | The account, card, or bank account that is credited or debited as part of the adjustment. | buyer_details.instrument_id, instrument_id, subscription_details.buyer_details.instrument_id |
| instrument_type | payment_instruments | string | The type of `Payment Instrument`. | instrument_type |
| interac_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each Interac Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | interac_basis_points |
| interac_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual Interac `Transfer`. | interac_fixed_fee |
| interval_count | subscription_links, subscriptions | integer | The number of intervals of `interval_type` used to describe the duration of the trial. | subscription_details.subscription_details.trial_details.interval_count, subscription_details.trial_details.interval_count |
| interval_type | subscription_links, subscriptions | string | The unit of time for the trial period. | subscription_details.discount_details.interval_type, subscription_details.subscription_details.discount_details.interval_type, subscription_details.subscription_details.trial_details.interval_type, subscription_details.trial_details.interval_type |
| invoice_reference_number | additional_purchase_data, authorizations, transfers | string | The order's invoice number (max 15 characters). | additional_purchase_data.invoice_reference_number |
| ip | authorizations, ip_address_details, transfers | string | The card brands require the customer's IP address for online gaming clients. Only supports Internet Protocol version 4 (IPv4). | ip_address_details.ipv4.ip |
| ip_address | compliance_forms, devices, onboarding_data, ... | string | The IP address of the signee. | connectivity.ip_address, onboarding_data.additional_underwriting_data.amex_marketing_consent.ip_address, pci_saq_a.ip_address |
| ip_address_details | authorizations, transfers | object | This field returns `null` for all users except `ROLE_PLATFORM` users. | ip_address_details |
| ip_address_v4 | authorizations, transfers | string | The card brands require the customer's IP address for online gaming clients. Only supports Internet Protocol version 4 (IPv4). | ip_address_v4 |
| ipv4 | authorizations, ip_address_details, transfers | object |  | ip_address_details.ipv4 |
| is_accepted | compliance_forms | boolean | Whether the signee has signed the form. | pci_saq_a.is_accepted |
| is_accepting_events | webhooks | boolean | Whether the webhook is accepting events. | is_accepting_events |
| is_authorization | checkout_forms, payment_links, transfer_attempts | boolean | When set to `true`, submitting the `Checkout Form` creates an `Authorization` instead of a `Transfer`. | is_authorization |
| is_charging | devices | boolean | Indicates whether the `Device` is charging. | power.is_charging |
| is_exception | settlements | boolean | Returns `true` if the `Settlement` contains items that were removed from a previous `Settlement`. | is_exception |
| is_multiple_use | payment_links, subscription_links | boolean | If set to `true`, the payment link can be used for multiple purchases. | is_multiple_use |
| is_terminated | merchants | boolean | Set to `true` to terminate the `Merchant`. A merchant can only be terminated if its current `onboarding_state` is `APPROVED`. | is_terminated |
| is_void | authorizations | boolean | Whether the `Authorization` has been voided. | is_void |
| issuer_code_table_index | authorizations, card_present_details, transfers | string | The alphabet code table (according to ISO 8859) used by the EMV application (if provided). Tag 9F11. | card_present_details.emv_data.issuer_code_table_index |
| issuer_country | payment_instruments, verifications | string | The Alpha-3 Code of the country the card was issued in. In addition, the following values are possible: - `NON_USA` - The card was issued outside of the United States. | issuer_country, payment_instrument_verification_details.issuer_country |
| item_data | additional_purchase_data, authorizations, transfers | array[object] | Additional information about the transaction. Used for Level 2 and Level 3 Processing. | additional_purchase_data.item_data |
| items | authorizations, checkout_forms, payment_links, ... | array[object] | An itemized list of products/services. This field is required for the transaction to qualify for Level 3 processing. | items, receipt_options.items |
| jcb_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each JCB Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | jcb_basis_points |
| jcb_charge_interchange | fee_profiles | integer | Set to `true` to incur interchange fees for JCB `Transfers`. | jcb_charge_interchange |
| jcb_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual JCB `Transfer`. | jcb_fixed_fee |
| label | fees | string | It is used for subscription fees and allows free-form text to be passed from the subscription fee product. Note that this product is mostly deprecated. | label |
| last_four | payment_instruments | string | The last four digits of the card. | last_four, new_instrument_details.last_four, old_instrument_details.last_four |
| last_name | applications, buyer_details, checkout_forms, ... | string | Last name of the buyer. | buyer_details.last_name, entity.last_name, entity_buyer.last_name, last_name, onboarding_data.entity.last_name, recipient_details.last_name |
| last_used_date | users | string (date-time) | Timestamp of when the user credentials were last used to make an API call. | last_used_date |
| latitude | authorizations, ip_address_details, transfers | number | Geo-location based on the IP address. | ip_address_details.ipv4.latitude |
| level_two_level_three_data_enabled | merchants | boolean | Set to `true` to enable the `Merchant` for Level 2 and Level 3 processing. Default value is `false`. | level_two_level_three_data_enabled |
| limit | page | integer | The number of entries to return. | page.limit |
| line1 | address, applications, authorizations, ... | string | First line of the address (max 35 characters). | address.line1, buyer_details.billing_address.line1, buyer_details.shipping_address.line1, entity.business_address.line1, entity.personal_address.line1, entity_buyer.business_address.line1, entity_buyer.personal_address.line1, ip_address_details.ipv4.estimated_location.line1, onboarding_data.entity.business_address.line1, onboarding_data.entity.personal_address.line1, recipient_details.business_address.line1, recipient_details.personal_address.line1, subscription_details.buyer_details.shipping_address.line1 |
| line2 | address, applications, authorizations, ... | string | Second line of the address (max 35 characters). | address.line2, buyer_details.billing_address.line2, buyer_details.shipping_address.line2, entity.business_address.line2, entity.personal_address.line2, entity_buyer.business_address.line2, entity_buyer.personal_address.line2, ip_address_details.ipv4.estimated_location.line2, onboarding_data.entity.business_address.line2, onboarding_data.entity.personal_address.line2, recipient_details.business_address.line2, recipient_details.personal_address.line2, subscription_details.buyer_details.shipping_address.line2 |
| link_expires_at | checkout_forms, payment_links, payout_links, ... | string | Timestamp of when the `Checkout ` will expire. | link_expires_at |
| link_url | checkout_forms, onboarding_forms, payment_links, ... | string | The URL of the user's Finix Onboarding Form. Users can use the `link_url` to return to the form until the link expires. | link_url, onboarding_link.link_url |
| linked_id | fees | string | The ID of the linked resource. Note that this field will be deprecated soon, use `linked_to` instead. | linked_id |
| linked_to | balances, compliance_forms, disbursement_rules, ... | string | The ID of the resource (e.g., an `Application`) that the `Balance` is linked to. | linked_to, subscription_details.linked_to |
| linked_type | balances, compliance_forms, disbursement_rules, ... | string | Specifies the type of resource identified in `linked_to`. | linked_type, subscription_details.linked_type |
| loan_repayment | identities, merchants | boolean | Whether the merchant is able to support loan repayment on the card networks. | loan_repayment |
| logo | branding, checkout_forms, payment_links, ... | string | URL of the logo for the payment link. | branding.logo |
| logo_alternative_text | branding, checkout_forms, payment_links, ... | string | Alternate text displayed if the logo image cannot display. | branding.logo_alternative_text |
| longitude | authorizations, ip_address_details, transfers | number | Geo-location based on the IP address. | ip_address_details.ipv4.longitude |
| mail_order_telephone_order_percentage | additional_underwriting_data, identities, onboarding_data, ... | integer | The percentage of the merchant's business that is a mail or telephone order (between 0 and 100). | additional_underwriting_data.card_volume_distribution.mail_order_telephone_order_percentage, onboarding_data.additional_underwriting_data.card_volume_distribution.mail_order_telephone_order_percentage |
| masked_account_number | authorizations, card_present_details, payment_instruments, ... | string | Last four digits of the bank account number. | card_present_details.masked_account_number, masked_account_number |
| mastercard_acquirer_fees_basis_points | fee_profiles | integer | A fee assessed on a business’s gross MasterCard processing volume. This fee varies per acquirer based on MasterCard’s assessed charge as it’s distributed across the acquirer’s portfolio of merchants. | mastercard_acquirer_fees_basis_points |
| mastercard_assessments_over1k_basis_points | fee_profiles | integer | Fee applied to Mastercard credit sale transactions greater than $1,000. | mastercard_assessments_over1k_basis_points |
| mastercard_assessments_under1k_basis_points | fee_profiles | integer | Fee applied to Mastercard transactions less than or equal to $1,000. | mastercard_assessments_under1k_basis_points |
| mastercard_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each MasterCard `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | mastercard_basis_points |
| mastercard_charge_dues_assessments | fee_profiles | integer | A fee associated with MasterCard's assessment of dues or ongoing charges for services provided through the MasterCard payment network. | mastercard_charge_dues_assessments |
| mastercard_charge_interchange | fee_profiles | boolean | Set to `true` to incur interchange fees for MasterCard `Transfers`. | mastercard_charge_interchange |
| mastercard_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual MasterCard `Transfer`. | mastercard_fixed_fee |
| max_amount | amount_details, checkout_forms, payment_links | integer | Maximum amount allowed when the amount is `VARIABLE`. This field is required when `amount_type` is `VARIABLE`. | amount_details.max_amount |
| max_transaction_amount | applications, disbursement_rules, entity, ... | integer | The maximum amount (in cents) that can be charged for a single transaction (max 12 characters). | entity.max_transaction_amount, entity_buyer.max_transaction_amount, maximum_transaction_amount.max_transaction_amount, onboarding_data.max_transaction_amount |
| mcc | entity, entity_buyer, identities, ... | string | The Merchant Category Code (MCC) that this merchant will be classified under. For a list of approved MCCs, see Approved Merchant Category Codes. | entity.mcc, entity_buyer.mcc, mcc, onboarding_data.entity.mcc |
| merchant | authorizations, devices, fees, ... | string | The ID of the `Merchant` resource the `Authorization` was created under. | merchant |
| merchant_ach_max_transaction_amount | onboarding_forms, onboarding_link_details | integer | The maximum transaction amount for the merchant's ACH payment processing. | onboarding_link_details.merchant_ach_max_transaction_amount |
| merchant_agreement_accepted | additional_underwriting_data, identities, onboarding_data, ... | boolean | Sets whether this merchant has accepted the terms and conditions of the merchant agreement. | additional_underwriting_data.merchant_agreement_accepted, onboarding_data.additional_underwriting_data.merchant_agreement_accepted |
| merchant_agreement_ip_address | additional_underwriting_data, identities, onboarding_data, ... | string | IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113). | additional_underwriting_data.merchant_agreement_ip_address, onboarding_data.additional_underwriting_data.merchant_agreement_ip_address |
| merchant_agreement_timestamp | additional_underwriting_data, identities, onboarding_data, ... | string | Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z). | additional_underwriting_data.merchant_agreement_timestamp, onboarding_data.additional_underwriting_data.merchant_agreement_timestamp |
| merchant_agreement_user_agent | additional_underwriting_data, identities, onboarding_data, ... | string | The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)). | additional_underwriting_data.merchant_agreement_user_agent, onboarding_data.additional_underwriting_data.merchant_agreement_user_agent |
| merchant_id | checkout_forms, payment_links, payout_links, ... | string | The ID of the `Merchant` resource the `payment_link` was created for and will settle under. | merchant_id, recipient_details.merchant_id |
| merchant_identity | authorizations, payment_instruments, transfers, ... | string | The ID of the `Identity` resource used by the `Merchant` the `Authorization` was processed under. | merchant_identity |
| merchant_max_transaction_amount | onboarding_forms, onboarding_link_details | integer | The maximum transaction amount for the merchant's card payment processing. | onboarding_link_details.merchant_max_transaction_amount |
| merchant_name | merchants | string | The legal name saved in the `Merchant` resource. | merchant_name |
| merchant_processors | onboarding_forms | array[object] | An array of objects with the processors and gateways users will be onboarded to. | merchant_processors |
| merchant_profile | merchants | string | Details if a merchant's info was submitted to third-party processors for provisioning. | merchant_profile |
| messages | authorizations, transfers, verifications | array[string] | Message field that provides additional details. This field is typically **null**. | messages |
| mid | merchants | string | MID of the `Merchant`. | mid, processor_details.mid |
| min_amount | amount_details, checkout_forms, payment_links | integer | Minimum amount allowed when the amount is `VARIABLE`. This field is required when `amount_type` is `VARIABLE`. | amount_details.min_amount |
| model | devices, merchants | string | The model type of the `Device`. | model |
| month | additional_purchase_data, applications, authorizations, ... | integer | Month of purchase (between 1 and 12). | additional_purchase_data.order_date.month, entity.dob.month, entity.incorporation_date.month, entity_buyer.dob.month, entity_buyer.incorporation_date.month, next_billing_date.month, onboarding_data.entity.dob.month, onboarding_data.entity.incorporation_date.month |
| monthly_velocity | disbursement_rules | object | An object that contains the current usage and limits for disbursements. | ach_velocity.monthly_velocity, balance_adjustment_velocity.monthly_velocity, card_velocity.monthly_velocity |
| name | authorizations, card_present_details, compliance_forms, ... | string | The name of the bank account or card owner. | card_present_details.name, name, onboarding_data.payment_instruments.name, pci_saq_a.name |
| net_amount | settlements | integer | The amount in cents that will be deposited into the merchant's bank account. | net_amount |
| network_details | transfers | object | Contains network-specific fields used by issuers to identify transactions. | network_details |
| network_token_enabled | applications, payment_instruments | boolean | When enabled at the `Payment Instrument` level, a "network token" replaces raw card details (e.g., the 16-digit PAN and expiration date) for transactions. Network tokens have several benefits: - Th... | network_token_enabled |
| network_token_state | payment_instruments | string | The state of the network token. The possible enum values are as follows: - `NOT_ENABLED`: The `network_token_state` is `NOT_ENABLED` when the value of `network_token_enabled` on the `Payment Instru... | network_token_state |
| network_type | devices | string | The type of network connection (e.g., Wi-Fi, cellular, ethernet). | connectivity.network_type |
| new_instrument_details | payment_instruments | object | Object containing the `Payment Instrument` details after the card update. | new_instrument_details |
| next_billing_date | subscriptions | object | Details when the next `Transfer` will occur. | next_billing_date |
| next_cursor | page | string | The cursor to use for the next page of results. | page.next_cursor |
| nickname | checkout_forms, payment_links, payout_links, ... | string | A human-readable name for the resource. | nickname, subscription_details.nickname |
| notification_preferences | subscription_links, subscriptions | object | Object containing notification preferences. | subscription_details.notification_preferences, subscription_details.subscription_details.notification_preferences |
| number | payment_instruments | string | The card or bank account number (no dashes in between numbers). | number |
| old_instrument_details | payment_instruments | object | Object containing the `Payment Instrument` details prior to the card update. | old_instrument_details |
| onboarding_data | onboarding_forms | object | The prefilled information of the user that's being onboarded. For more information, see Prefilling Fields. | onboarding_data |
| onboarding_link | onboarding_forms | object | The information of the initial onboarding link. This is only provided when creating an `onboarding_form`. | onboarding_link |
| onboarding_link_details | onboarding_forms | object | The information of the initial onboarding link. This is only provided when creating an `onboarding_form`. | onboarding_link_details |
| onboarding_state | merchants | string | Details the state of the `Merchant's` onboarding. | onboarding_state |
| online_gambling_block_indicator | payment_instruments | string | Details if the card is enabled to receive push-payments for online gambling payouts. | online_gambling_block_indicator |
| operating_system_time | devices | string (date-time) | The current time recorded from the device's operating system. | system.operating_system_time |
| operation_key | authorizations, transfer_attempts, transfers | string | Details the operation that's performed in the transaction. | operation_key |
| order_date | additional_purchase_data, authorizations, transfers | object |  | additional_purchase_data.order_date |
| other_volume_percentage | additional_underwriting_data, identities, onboarding_data, ... | integer | The percentage of the merchant's volume that isn't represented by the previous fields (between 0 and 100). | additional_underwriting_data.volume_distribution_by_business_type.other_volume_percentage, onboarding_data.additional_underwriting_data.volume_distribution_by_business_type.other_volume_percentage |
| outcome_summary | verifications | string | A message providing additional context about why the verification request failed, available for `SELLER` merchants only. | outcome_summary |
| outcomes | verifications | array[object] | A codified list of reasons the verification request failed, available for `SELLER` merchants only. | outcomes |
| ownership_type | entity, entity_buyer, identities, ... | string | Values can be either: PUBLIC to indicate a publicly-traded company. PRIVATE for privately-held businesses. | entity.ownership_type, entity_buyer.ownership_type, onboarding_data.entity.ownership_type |
| parent_balance_entry_id | balances | string | The `parent_balance_entry_id` refers to the ID of the original `Balance Entry`. This is only applicable for transactions that have been reversed after being posted (i.e., the `state` is set to `RET... | parent_balance_entry_id |
| parent_entity_id | settlements | string | The ID of the original parent resource where the transaction occurred. This is only populated when `sub_type` is `FEE`. | parent_entity_id |
| parent_entity_type | settlements | string | The type of the original parent resource where the transaction occurred. This is only populated when `sub_type` is `FEE`. | parent_entity_type |
| parent_transfer | transfers | string | - ID of the original parent `Transfer` where the transaction occurred. - Only is present when `type` is `REVERSAL` or `FEE`. | parent_transfer |
| parent_transfer_id | split_transfers | string | The ID of the original parent `Transfer` that was split. | parent_transfer_id |
| parent_transfer_trace_id | transfers | string | - The `trace_id` of the original parent `Transfer` where the transaction occurred. - Only visible when `type` is `REVERSAL` or `FEE`. | parent_transfer_trace_id |
| partial_authorization | authorizations, transfers | boolean | - Set to **true** if you want to enable partial authorizations for a specific transaction. - If `partial_authorization` is enabled for an individual transaction, the `Merchant` value for `default_p... | partial_authorization |
| password | users, webhooks | string | The `password` you'll use to authetnicate requests. | authentication.basic.password, password |
| payload_type | payment_instruments | string |  | payload_type |
| payment_app | devices | object | Details of the payment application running on the device. | payment_app |
| payment_app_version | devices | string | The device’s current app version. | payment_app_version |
| payment_frequency | checkout_forms, payment_links, transfer_attempts | string | Details if a payment created from a checkout form is: ONE_TIME RECURRING At this time, only **ONE_TIME** is supported. | payment_frequency |
| payment_instrument | verifications | string | This field is not applicable to merchant verification. | payment_instrument |
| payment_instrument_id | payment_instruments, transfer_attempts | string | The `Payment Instrument` that triggered the creation of this `Instrument History Entry`. | payment_instrument_id |
| payment_instrument_type | payment_instruments | string | The type of `Payment Instrument` that triggered this `Instrument History Entry`. | payment_instrument_type |
| payment_instrument_verification_details | verifications | object | This object is not applicable to merchant verification. | payment_instrument_verification_details |
| payment_instruments | onboarding_data, onboarding_forms | object | The `Payment Instrument` that'll be used to payout the seller. For more information, see Payouts. | onboarding_data.payment_instruments |
| payment_type | authorizations, card_present_details, settlements, ... | string | The type of `Payment Instrument` used in the transaction (or the original payment). | card_present_details.payment_type, payment_type |
| payout_profile_id | settlements | string | The ID of the `Payout Profile` that was used to generate the `Settlement`. | payout_profile_id |
| pci_saq_a | compliance_forms | object | Details about the signee's digital signature | pci_saq_a |
| pending_amount | balances | integer | The projected balance after all in-flight transactions are finalized. This amount includes the posted balance adjusted by pending incoming and outgoing transactions, regardless of whether those fun... | pending_amount |
| percent_options | device_configuration, devices, merchants | array[object] | Sets the percentages that will be displayed on the terminal. Defaults to `[18, 20, 22]`. | configuration.tipping_details.percent_options, device_configuration.tipping_details.percent_options |
| percent_tipping_threshold | device_configuration, devices, merchants | integer | The inclusive value at which the terminal will present a percent based prompt instead of a fixed value prompt. Defaults to `false`. | configuration.tipping_details.percent_tipping_threshold, device_configuration.tipping_details.percent_tipping_threshold |
| person_to_person_volume_percentage | additional_underwriting_data, identities, onboarding_data, ... | integer | The percentage the merchant's volume that's person to person (between 0 and 100). | additional_underwriting_data.volume_distribution_by_business_type.person_to_person_volume_percentage, onboarding_data.additional_underwriting_data.volume_distribution_by_business_type.person_to_person_volume_percentage |
| personal_address | applications, entity, entity_buyer, ... | object | The billing address of the buyer. This field is used for identity verification purposes. | entity.personal_address, entity_buyer.personal_address, onboarding_data.entity.personal_address, recipient_details.personal_address |
| personal_tax_id_provided | transfer_attempts | boolean | Whether a personal tax ID was provided by the recipient. | recipient_details.personal_tax_id_provided |
| phone | applications, entity, entity_buyer, ... | string | Phone number where the buyer can be reached. | buyer_details.phone, entity.phone, entity_buyer.phone, onboarding_data.entity.phone, recipient_details.phone |
| phone_number | buyer_details, checkout_forms | string | Phone number of the buyer. | buyer_details.phone_number |
| pin_verified | authorizations, card_present_details, transfers | boolean | Whether the cardholder's PIN number was verified. | card_present_details.emv_data.pin_verified |
| plans | subscription_links | array[object] | A list of `Subscription Plan` objects, along with additional information for each plan if selected. | plans |
| platform_id | files, settlement_queue_entries | string | The ID of the `Platform` that the `File` was created under. | platform_id |
| postal_code | address, applications, authorizations, ... | string | Zip or Postal code (max 7 characters). | address.postal_code, buyer_details.billing_address.postal_code, buyer_details.shipping_address.postal_code, entity.business_address.postal_code, entity.personal_address.postal_code, entity_buyer.business_address.postal_code, entity_buyer.personal_address.postal_code, ip_address_details.ipv4.estimated_location.postal_code, onboarding_data.entity.business_address.postal_code, onboarding_data.entity.personal_address.postal_code, recipient_details.business_address.postal_code, recipient_details.personal_address.postal_code, subscription_details.buyer_details.shipping_address.postal_code |
| posted_amount | balances | integer | The total balance derived only from finalized, settled transactions. This amount represents the authoritative ledger balance and does not include any pending incoming or outgoing transactions. | posted_amount |
| posted_at | balances | string (date-time) | Timestamp of when the `Balance Entry` was posted and finalized on the `Balance` (i.e., state changed to `SUCCEEDED`). This field is `null` if the entry has not been posted. | posted_at |
| power | devices | object | Device power details. | power |
| prescription_amount | additional_healthcare_data, authorizations, transfers | integer | The prescription/RX amount for the transaction. | additional_healthcare_data.prescription_amount |
| previous_secret_expires_at | webhooks | string | The time when the previous `secret_signing_key` will expire. This is **null** when the webhook is initially created. | previous_secret_expires_at |
| primary_image_url | image_details | string | The primary image location. | image_details.primary_image_url |
| principal_percentage_ownership | entity, entity_buyer, identities, ... | integer | Percentage of the company owned by the principal control owner (min 0; max 100). | entity.principal_percentage_ownership, entity_buyer.principal_percentage_ownership, onboarding_data.entity.principal_percentage_ownership |
| processing_enabled | merchants | boolean | Details if transaction processing is enabled for the `Merchant`. `ROLE_PARTNER` can only set this value to `false`. | processing_enabled |
| processor | balance_adjustments, identities, merchants, ... | string | The payment processing entity responsible for handling transactions, fund movements, etc., between different financial accounts. | processor |
| processor_details | merchants | object | Additional details specific to the processor. | processor_details |
| prompt_amount_confirmation | device_configuration, devices, merchants | boolean | Sets if the cardholder needs to confirm the amount they'll pay. `DATACAP_V1` only. | configuration.prompt_amount_confirmation, device_configuration.prompt_amount_confirmation |
| prompt_for_signature | device_configuration, devices, merchants | string | Determines when the terminal prompts for an e-signature. - `ALWAYS`: The terminal will always request an e-signature. | configuration.prompt_for_signature, device_configuration.prompt_for_signature |
| prompt_manual_entry | device_configuration, devices, merchants | boolean | Sets if the device allows for manual entry as a card input method. `DATACAP_V1` and `FINIX_V1` only. | configuration.prompt_manual_entry, device_configuration.prompt_manual_entry |
| prompt_receipt_confirmation | device_configuration, devices, merchants | boolean | Sets whether or not the device presents a screen prompting the buyer to print receipt at the end of the transaction flow. `FINIX_V1` and `DUMMY_V1` only. | configuration.prompt_receipt_confirmation, device_configuration.prompt_receipt_confirmation |
| prompt_signature | devices | string | When to prompt for a signature. | prompt_signature |
| prompt_tip_on_screen | device_configuration, devices, merchants | boolean | Sets whether the device will display the suggested tipping screen. `FINIX_V1` and `DUMMY_V1` only. | configuration.prompt_tip_on_screen, device_configuration.prompt_tip_on_screen |
| push_funds_block_indicator | payment_instruments | string | Details if the card is enabled to receive push-to-card disbursements. | push_funds_block_indicator |
| push_to_card_cross_border | verifications | string | This object is not applicable to merchant verification. | payment_instrument_verification_details.push_to_card_cross_border |
| push_to_card_domestic | verifications | string | This object is not applicable to merchant verification. | payment_instrument_verification_details.push_to_card_domestic |
| qualified_tiers | fee_profiles | object | The top of the qualified tier tree. | qualified_tiers |
| rail | balance_adjustments, settlements | string | The method of adjustment. | rail |
| ram_usage_percent | devices | number (float) | The percentage of the device's RAM that is currently in use. | system.ram_usage_percent |
| raw | authorizations, transfers, verifications | object | Raw response from the processor. | raw |
| ready_to_settle_after | settlement_queue_entries | string (date-time) | A timestamp indicating when the `Settlement Queue Entry` can be processed for settlement. | ready_to_settle_after |
| ready_to_settle_at | fees, settlements, split_transfers, ... | string (date-time) | The timestamp indicating when the `Transfer` related to this `Fee` is ready to be settled. The specific `Transfer` is identified by the `linked_to` field. | ready_to_settle_at |
| ready_to_settle_upon | merchants | string | Details how transactions captured by the `Merchant` are settled. | ready_to_settle_upon |
| ready_to_settle_upon_delay_alignment | merchants | string | Indicates whether transaction settlement should be delayed to synchronize the timing of all transactions, including both card and ACH, ensuring they are settled together. Possible values include: -... | ready_to_settle_upon_delay_alignment |
| reason | merchants | string | The reason for termination. | termination_details.reason |
| reason_code | transfers | string | Return response code from the bank. | bank_return_details.reason_code |
| reason_message | transfers | string | Detailed message explaining reason for the return. | bank_return_details.reason_message |
| reason_title | transfers | string | Short message categorizing reason for the return. | bank_return_details.reason_title |
| receipt_last_printed_at | authorizations, transfers | string (date-time) | Timestamp when the receipt was last printed. | receipt_last_printed_at |
| receipt_options | authorizations, transfers | object | If provided the information will be used to generate a receipt if transaction is successful. | receipt_options |
| receipt_requested_delivery_methods | additional_details, subscription_links, transfer_attempts | array[object] | A list of requested delivery methods. Each method specifies the type of delivery and the destination(s) where the receipt should be sent. | additional_details.receipt_requested_delivery_methods, receipt_requested_delivery_methods |
| recipient_details | disbursement_rules, payout_links, transfer_attempts | object | A container for rule configurations. | recipient_details |
| recipient_merchant_id | transfer_attempts | string | The `Merchant` resource linked to the recipient targeted by the `Payout Link`. | recipient_merchant_id |
| refund_amount | transfers | integer | The amount of the refund in cents. It must be equal to or less than the amount of the original `Transfer`. | refund_amount |
| refund_policy | additional_underwriting_data, identities, onboarding_data, ... | string | Include the value that best applies to the merchant's refund policy. | additional_underwriting_data.refund_policy, onboarding_data.additional_underwriting_data.refund_policy |
| refunds_disabled | applications, identities, merchants | boolean | A value of `true` disables refunds for the `Merchant`, including both referenced and unreferenced refunds. | refunds_disabled |
| region | address, applications, authorizations, ... | string | 2-letter State code. | address.region, buyer_details.billing_address.region, buyer_details.shipping_address.region, entity.business_address.region, entity.personal_address.region, entity_buyer.business_address.region, entity_buyer.personal_address.region, ip_address_details.ipv4.estimated_location.region, onboarding_data.entity.business_address.region, onboarding_data.entity.personal_address.region, recipient_details.business_address.region, recipient_details.personal_address.region, subscription_details.buyer_details.shipping_address.region |
| rent_surcharge_amount | additional_buyer_charges, amount_breakdown, amount_breakdown_level2_level3, ... | integer | A rent surcharge to charge the buyer for the transaction. This object property is mutually exclusive. | additional_buyer_charges.rent_surcharge_amount, amount_breakdown.additional_buyer_charges.rent_surcharge_amount, amount_breakdown_level2_level3.additional_buyer_charges.rent_surcharge_amount, amount_details.amount_breakdown.additional_buyer_charges.rent_surcharge_amount, receipt_options.amount_breakdown.additional_buyer_charges.rent_surcharge_amount |
| rent_surcharges_enabled | merchants | boolean | Set to `true` if you want to enable a `Merchant` to accept rent charges. | rent_surcharges_enabled |
| requested_delivery_methods | authorizations, payment_links, subscription_links, ... | array[object] | A list of requested delivery methods. Each method specifies the type of delivery and the destination(s) where the receipt should be sent. | buyer_details.requested_delivery_methods, receipt_options.requested_delivery_methods, requested_delivery_methods, subscription_details.buyer_details.requested_delivery_methods |
| return_url | onboarding_forms, onboarding_link_details | string | The URL users get sent to after completing the onboarding flow. | onboarding_link_details.return_url |
| risk_profile | application_profiles | string | The ID of the `Risk Profile` that was created during provisioning. | risk_profile |
| role | users | string | Details the level of access the `User` has available. | role |
| rounding_mode | fee_profiles | string | Set to `AGGREGATE` to round after the settlement calculation. By default, rounding happens before the sum of the settlement calculation (i.e., round each fee transfer). | rounding_mode |
| rules | disbursement_rules | array[object] | A list of rules for DAILY time frame. | daily_rule_configuration.rules, monthly_rule_configuration.rules, rule_configuration.rules |
| sales_tax | additional_purchase_data, authorizations, transfers | integer | - Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts. | additional_purchase_data.sales_tax |
| sales_tax_finix_generated | additional_purchase_data, authorizations, transfers | integer |  | additional_purchase_data.sales_tax_finix_generated |
| secret_signing_key | webhooks | string | The secret signing key that gets used to verify webhook events. | secret_signing_key |
| security_code | authorizations, payment_instruments, transfers | string | The 3-4 digit security code for the card (i.e. CVV code). | security_code |
| security_code_verification | authorizations, payment_instruments, transfers | string | Details the results of the Security Code Verification che | security_code_verification |
| send_confirmation | subscription_links, subscriptions | boolean | Setting this flag to `true` validates the provided email address and sends a confirmation email to that address. When set to `true`, the `collect_email` field must include an email. | additional_details.send_confirmation, subscription_details.notification_preferences.send_confirmation, subscription_details.subscription_details.notification_preferences.send_confirmation |
| send_invoice | subscriptions | boolean | Whether to send the user an invoice. | subscription_details.send_invoice |
| send_receipt | additional_details, subscription_links, subscriptions | boolean | Whether to send the user a `Receipt`. | additional_details.send_receipt, subscription_details.send_receipt |
| sender_details | disbursement_rules | object | A container for rule configurations. | sender_details |
| serial_number | devices, merchants | string | The serial_number is a unique identifier for the `Device`, located on the back and typically composed of ~16 digits. Ensure the serial number is set before activating the `Device`, though it can al... | serial_number |
| session_details | payment_instruments | string | Details about the `apple_pay_session` that was created. | session_details |
| settlement_approval_enabled | applications | boolean | This flag determines if `ROLE_PARTNER`s associated with this `Application` can approve settlements. It lets customers allow partners to add items to exception settlements and approve them. | settlement_approval_enabled |
| settlement_enabled | merchants | boolean | Details if settlement approvals are enabled for the `Merchant`. `ROLE_PARTNER` can only set this value to false. | settlement_enabled |
| settlement_entry_ids | settlements | array[string] | The ID of `Settlement Entry` resource. | settlement_entry_ids |
| settlement_funding_identifier | merchants | string | Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors. - `UNSET`: No additional details get provided to the processor. | settlement_funding_identifier |
| settlement_funding_transfer_ach_basis_points | fee_profiles | integer | A percentage-based fee applied to ACH transfers related to settlement funding. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | settlement_funding_transfer_ach_basis_points |
| settlement_funding_transfer_ach_basis_points_fee_limit | fee_profiles | integer | The maximum percentage-based fee (in cents) incurred for each individual Settlement Funding Transfer (ACH). | settlement_funding_transfer_ach_basis_points_fee_limit |
| settlement_funding_transfer_ach_credit_return_fixed_fee | fee_profiles | integer | A fixed fee (in cents) charged to the platform or seller when receiving a credit return related to a Settlement Funding Transfer (ACH). | settlement_funding_transfer_ach_credit_return_fixed_fee |
| settlement_funding_transfer_ach_debit_return_fixed_fee | fee_profiles | integer | A fixed fee (in cents) charged to the platform or seller when receiving a Debit Return related to a Settlement Funding Transfer (ACH). | settlement_funding_transfer_ach_debit_return_fixed_fee |
| settlement_funding_transfer_ach_fixed_fee | fee_profiles | integer | A flat fee (in cents) incurred for each individual Settlement Funding Transfer (ACH). | settlement_funding_transfer_ach_fixed_fee |
| settlement_funding_transfer_eft_basis_points | fee_profiles | integer | The percentage-based fee applied to the total amount of a settlement funding `Transfer` made via an EFT from a Canadian-based bank account. Measured in basis points, where 1 basis point equals 0.01... | settlement_funding_transfer_eft_basis_points |
| settlement_funding_transfer_eft_basis_points_fee_limit | fee_profiles | integer | The maximum percentage-based fee (in cents) incurred for each individual settlement funding `Transfer` made via an EFT. | settlement_funding_transfer_eft_basis_points_fee_limit |
| settlement_funding_transfer_eft_credit_return_fixed_fee | fee_profiles | integer | A fixed fee (in cents) charged for processing a Credit Return related to a settlement funding `Transfer`. This occurs when funds are returned from a Canadian-based bank account back to the seller's... | settlement_funding_transfer_eft_credit_return_fixed_fee |
| settlement_funding_transfer_eft_debit_return_fixed_fee | fee_profiles | integer | A fixed fee (in cents) charged for processing a Debit Return related to a settlement funding `Transfer`. This occurs when funds are returned from the seller's account to a Canadian-based bank accou... | settlement_funding_transfer_eft_debit_return_fixed_fee |
| settlement_funding_transfer_eft_fixed_fee | fee_profiles | integer | A flat fee (in cents) incurred for each settlement funding `Transfer` made via an EFT from a Canadian-based bank account. This fee is independent of the payment amount. | settlement_funding_transfer_eft_fixed_fee |
| settlement_funding_transfer_instant_payout_card_basis_points | fee_profiles | integer | The percentage-based fee applied to the total amount of a settlement funding `Transfer` made as an instant payout to a card. Measured in basis points, where 1 basis point equals 0.01% (e.g., 100 ba... | settlement_funding_transfer_instant_payout_card_basis_points |
| settlement_funding_transfer_instant_payout_card_basis_points_fee_limit | fee_profiles | integer | The maximum percentage-based fee (in cents) incurred for each individual settlement funding `Transfer` made as an instant payout to a card. | settlement_funding_transfer_instant_payout_card_basis_points_fee_limit |
| settlement_funding_transfer_instant_payout_card_fixed_fee | fee_profiles | integer | A flat fee (in cents) incurred for each settlement funding `Transfer` made as an instant payout to a card. | settlement_funding_transfer_instant_payout_card_fixed_fee |
| settlement_funding_transfer_noc_credit_fixed_fee | fee_profiles | integer | A fixed fee (in cents) charged for processing a Notification of Change (NOC) related to a credit transaction in settlement funding transfers. | settlement_funding_transfer_noc_credit_fixed_fee |
| settlement_funding_transfer_noc_debit_fixed_fee | fee_profiles | integer | A fixed fee (in cents) charged for processing a Notification of Change (NOC) related to a debit transaction in settlement funding transfers. | settlement_funding_transfer_noc_debit_fixed_fee |
| settlement_funding_transfer_same_day_ach_basis_points | fee_profiles | integer | A percentage-based fee applied to ACH transfers related to settlement funding. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | settlement_funding_transfer_same_day_ach_basis_points |
| settlement_funding_transfer_same_day_ach_basis_points_fee_limit | fee_profiles | integer | The maximum percentage-based fee (in cents) incurred for each individual Settlement Funding Transfer (ACH). | settlement_funding_transfer_same_day_ach_basis_points_fee_limit |
| settlement_funding_transfer_same_day_ach_fixed_fee | fee_profiles | integer | A flat fee (in cents) incurred for each settlement funding `Transfer` made via same-day ACH. | settlement_funding_transfer_same_day_ach_fixed_fee |
| settlement_id | settlements | object | The ID of the `Settlement` resource used for this `Funding Transfer Attempt`. | settlement_id |
| settlement_queue_mode | merchants | string | If `settlement_queue_mode` is set to `MANUAL`, Finix will automatically place all transactions (Sales, Fees, Refunds, and ACH Returns) into a settlement queue that you can manage. Each transaction ... | settlement_queue_mode |
| ship_from_postal_code | additional_purchase_data, authorizations, transfers | string | The postal code from where order is shipped (10 characters). | additional_purchase_data.ship_from_postal_code |
| shipping_address | buyer_details, checkout_forms, subscription_links, ... | object | Shipping or mailing address of the buyer. | buyer_details.shipping_address, subscription_details.buyer_details.shipping_address |
| shipping_amount | additional_purchase_data, amount_breakdown, amount_breakdown_level2_level3, ... | integer | The shipping cost in cents for the order. | additional_purchase_data.shipping_amount, amount_breakdown.shipping_amount, amount_breakdown_level2_level3.shipping_amount, amount_details.amount_breakdown.shipping_amount, receipt_options.amount_breakdown.shipping_amount |
| short_business_name | entity, entity_buyer, identities, ... | string | Abbreviated names of the business. If there are no abbreviated name, leave this field blank. | entity.short_business_name, entity_buyer.short_business_name, onboarding_data.entity.short_business_name |
| should_fund | settlements | boolean | Indicates whether funds should be moved for this `Settlement Entry`. | should_fund |
| signal_strength | devices | string | The network connection strength. | connectivity.signal_strength |
| signature_threshold_amount | device_configuration, devices, merchants | object | The transaction amount at which the terminal prompts for an e-signature. | configuration.signature_threshold_amount, device_configuration.signature_threshold_amount |
| signed_at | compliance_forms | string | The timestamp of the signee's signature. | pci_saq_a.signed_at |
| signed_file | compliance_forms | string | The ID of the `File` resource for the signed `Compliance Form` PDF. | files.signed_file |
| size_in_bytes | files | integer | The size of the uploaded `File` in bytes. It is set to `null` when the `File` resource is first created and updates automatically after a `File` is uploaded. | size_in_bytes |
| source | authorizations, transfers | string | ID of the `Payment Instrument` where funds get debited. | source |
| split_transfers | authorizations, checkout_forms, payment_links, ... | array[object] | An array used to detail how funds from the `Transfer` will split and the amount `Merchants` receive. Rules: - The combined `amounts` under `split_transfers` must be equal to the `amount` submitted ... | split_transfers |
| start_date | disbursement_rules | integer | The day of the month that the rule resets. | monthly_rule_configuration.start_date |
| start_subscription_at | subscription_links, subscriptions | string (date-time) | Indicates that the subscription is scheduled to begin in the future. The timestamp specifies the exact start date for subscription billing. | start_subscription_at, subscription_details.start_subscription_at |
| start_time | disbursement_rules | integer | The time at which the rule resets. Accepts a value between `0` to `24`. | daily_rule_configuration.start_time, monthly_rule_configuration.start_time, rule_configuration.start_time |
| state | authorizations, balance_adjustments, balances, ... | string | The state of the `Authorization`. | payment_app.state, state |
| statement_descriptor | authorizations, transfers | string | The description of the `Merchant` that appears on the buyer's bank or card statement. | statement_descriptor |
| status | files, onboarding_forms, settlements | string | The file's upload status. | status |
| subscription_ach_basis_points | fee_profiles | integer | The percentage-based fee incurred against the full amount of each ACH Direct Debit transaction created from a `Subscription`. Calculated as one hundredth of one percent (1 basis point = .0001 or .0... | subscription_ach_basis_points |
| subscription_ach_basis_points_fee_limit | fee_profiles | integer | The maximum `subscription_ach_basis_points` fee (in cents) incurred for each individual `Transfer` created from a `Subscription`. | subscription_ach_basis_points_fee_limit |
| subscription_ach_fixed_fee | fee_profiles | integer | The fee in cents incurred for each individual ACH Direct Debit transaction created from a `Subscription`. | subscription_ach_fixed_fee |
| subscription_card_basis_points | fee_profiles | integer | The percentage-based fee incurred against the full amount of each card-based transaction created from a `Subscription`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | subscription_card_basis_points |
| subscription_card_fixed_fee | fee_profiles | integer | The percentage-based fee incurred against the full amount of each EFT transaction created from a `Subscription`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | subscription_card_fixed_fee |
| subscription_details | subscription_links, subscriptions | object | An object containing subscription details. | subscription_details, subscription_details.subscription_details |
| subscription_eft_basis_points | fee_profiles | integer | The percentage-based fee incurred against the full amount of each EFT transaction created from a `Subscription`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%). | subscription_eft_basis_points |
| subscription_eft_basis_points_fee_limit | fee_profiles | integer | The maximum `subscription_eft_basis_points` fee (in cents) incurred for each individual `Transfer` created from a `Subscription`. | subscription_eft_basis_points_fee_limit |
| subscription_eft_fixed_fee | fee_profiles | integer | The fee in cents incurred for each individual EFT transaction created from a `Subscription`. | subscription_eft_fixed_fee |
| subscription_link_id | subscriptions | string | The ID of the `Subscription Link` that created the `Subscription`. | subscription_link_id |
| subscription_phase | subscriptions | string | Indicates the period within a subscription where specific rules apply. - `EVERGREEN` - The buyer is billed continuously for the subscription until the subscription is canceled. | subscription_phase |
| subscription_plan_id | subscriptions | string | The ID of the `Subscription Plan` from which to create the `Subscription`. | subscription_plan_id |
| subtotal_amount | amount_breakdown, amount_breakdown_level2_level3, amount_details, ... | integer | The subtotal amount before any taxes, shipping, or additional charges are applied. | amount_breakdown.subtotal_amount, amount_breakdown_level2_level3.subtotal_amount, amount_details.amount_breakdown.subtotal_amount, receipt_options.amount_breakdown.subtotal_amount |
| subtype | settlements, transfers | string | The subtype of the `Settlement Entry`. - `DISPUTE_MERCHANT_DEBIT`: A `Settlement Entry` for a Split Transfer created when a Dispute pulls funds from a merchant proportionally. | subtype |
| success_return_url | additional_details, additional_details_payout, payout_links, ... | string | A URL to redirect the recipient to after the payout is successful. | additional_details.success_return_url, additional_details_payout.success_return_url |
| supplemental_fee | authorizations, transfers | string | Amount in cents for which an additional fee will be created in addition to any fees created from the assigned fee profile. | supplemental_fee |
| surcharge_amount | additional_buyer_charges, amount_breakdown, amount_breakdown_level2_level3, ... | integer | A surcharge amount to charge the buyer for the transaction. This object property is mutually exclusive. | additional_buyer_charges.surcharge_amount, amount_breakdown.additional_buyer_charges.surcharge_amount, amount_breakdown_level2_level3.additional_buyer_charges.surcharge_amount, amount_details.amount_breakdown.additional_buyer_charges.surcharge_amount, receipt_options.amount_breakdown.additional_buyer_charges.surcharge_amount |
| surcharge_basis_points | device_configuration, devices, merchants | integer | Represents the transaction amount that a `Merchant` charges the buyer when creating a `Transfer` or an `Authorization`. The value cannot exceed `300` (i.e., 3%). | configuration.surcharge_basis_points, device_configuration.surcharge_basis_points |
| surcharge_fees_enabled | merchants | boolean | Set to **true** if you want to enable a `Merchant` to accept surcharge fees. | surcharge_fees_enabled |
| surcharges_enabled | merchants | boolean | Set to `true` if you want to enable a `Merchant` to accept surcharge fees. For more details, see Buyer Charges. | surcharges_enabled |
| system | devices | object | Device system details. | system |
| tags | application_profiles, applications, authorizations, ... | object | Include up to 50 `key: value` pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. | card_present_details.emv_data.tags, tags |
| tax_authority | entity, entity_buyer, identities, ... | string | Only required when onboarding a merchant with a MCC of 9311 . The tax_authority is the tax gathering entity (e.g., San Francisco Water Authority). | entity.tax_authority, entity_buyer.tax_authority, onboarding_data.entity.tax_authority |
| tax_exempt | additional_purchase_data, amount_breakdown_level2_level3, amount_details, ... | boolean | - For tax exempt purchases set to **True**. - If set to **True**, request can't include `sales_tax`. | additional_purchase_data.tax_exempt, amount_breakdown_level2_level3.tax_exempt, amount_details.amount_breakdown.tax_exempt |
| tax_id | applications, onboarding_data, onboarding_forms | string | The control owner's Social Security Number (SSN). Masked in responses (e.g., `*****3333`). | entity.tax_id, onboarding_data.entity.tax_id |
| tax_id_provided | onboarding_data, onboarding_forms | boolean | Details if the `tax_id` was provided. | onboarding_data.entity.tax_id_provided |
| terminated_at | merchants | string (date-time) | Timestamp indicating when the termination occurred. | termination_details.terminated_at |
| terminated_by | merchants | string | The role that initiated the termination. If the API key belongs to the `USER` role, the following values will be returned: - If the role is `ROLE_PLATFORM`, it will return `PLATFORM_USER`. | termination_details.terminated_by |
| terminated_by_user_id | merchants | string | The `User` ID of the user who initiated the termination of the `Merchant` account. | termination_details.terminated_by_user_id |
| termination_details | merchants | object |  | termination_details |
| terms_of_service_url | additional_details, additional_details_payout, onboarding_forms, ... | string | Your Terms of Service URL. The URL is provided to users for consent along with Finix's Terms of Service. | additional_details.terms_of_service_url, additional_details_payout.terms_of_service_url, onboarding_link_details.terms_of_service_url |
| third-party | payment_instruments | string | This field is not applicable to bank accounts. | third-party |
| third_party | payment_instruments | string | A third-party service that allows for connecting to a bank account. | third_party |
| third_party_token | payment_instruments | string | This field is not applicanle to bank accounts. | third_party_token |
| time_frame | disbursement_rules | string | How often the rule resets. For this schema, always `DAILY`. | daily_rule_configuration.time_frame, monthly_rule_configuration.time_frame, rule_configuration.time_frame |
| time_zone | devices, disbursement_rules | string | The device's time zone. | daily_rule_configuration.time_zone, monthly_rule_configuration.time_zone, rule_configuration.time_zone, system.time_zone |
| timestamp | onboarding_data, onboarding_forms | string | Timestamp of when the merchant provided their marketing consent decision (ISO 8601 format). | onboarding_data.additional_underwriting_data.amex_marketing_consent.timestamp |
| tip_amount | amount_breakdown, amount_breakdown_level2_level3, amount_details, ... | integer | The tip amount included in the order total. | amount_breakdown.tip_amount, amount_breakdown_level2_level3.tip_amount, amount_details.amount_breakdown.tip_amount, receipt_options.amount_breakdown.tip_amount, tip_amount |
| tipping_details | device_configuration, devices, merchants | object | An object that sets the configurations for the tipping page if it appears. `FINIX_V1` and `DUMMY_V1` only. | configuration.tipping_details, device_configuration.tipping_details |
| title | compliance_forms, entity, entity_buyer, ... | string | The job title of the signee. | entity.title, entity_buyer.title, onboarding_data.entity.title, pci_saq_a.title |
| token | payment_instruments, webhooks | string | ID of the `Token` that was returned from the tokenization client or hosted fields | authentication.bearer.token, token |
| top_up_config_id | balance_adjustments | string | The ID of the top-up configuration that created the adjustment. | top_up_config_id |
| total_amount | amount_details, checkout_forms, payment_links, ... | integer | The total amount. | amount_details.total_amount, total_amount |
| total_billing_intervals | subscription_links, subscriptions | integer | The total number of billing intervals for the `Subscription`. This represents the total count of recurring billing cycles, such as months or weeks, depending on the billing frequency. | subscription_details.total_billing_intervals, total_billing_intervals |
| total_fee | settlements | integer | The sum of the fees in the `Settlement`. | total_fee |
| total_fees | settlements | integer | The sum of the fees in the `Settlement`, including subscription billing fees. | total_fees |
| trace_id | authorizations, balance_adjustments, transfers, ... | string | Trace ID of the `Authorization`. The processor sends back the `trace_id` so you can track the authorization end-to-end. | trace_id |
| transaction_date | balances | string (date-time) | The date of the transaction. | transaction_date |
| transaction_id | 3d_secure_authentication, authorizations, transfers | string | Unique identifier for the 3D Secure transaction. | 3d_secure_authentication.transaction_id |
| transfer | authorizations | string | The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**. | transfer |
| transfer_id | transfer_attempts | string | The `Transfer` associated with the `Transfer Attempt`. | transfer_id |
| transfers | settlements | array[string] | The ID of `Transfer` resource. | transfers |
| transit_number | payment_instruments | string | Canadian branch/branch-transit identifier (EFT). Exactly 5 digits that identify the branch where the account is held. | transit_number |
| trial_details | subscription_links, subscriptions | object | Object containing trial details. | subscription_details.subscription_details.trial_details, subscription_details.trial_details |
| trial_expected_end_at | subscriptions | string (date-time) | A timestamp indicating when the trial period ends. | subscription_details.trial_details.trial_expected_end_at |
| trial_expected_start_at | subscriptions | string (date-time) | A timestamp indicating when the trial period is expected to start. | subscription_details.trial_details.trial_expected_start_at |
| trial_started_at | subscriptions | string (date-time) | A timestamp indicating when the trial period began. | subscription_details.trial_details.trial_started_at |
| type | authorizations, balance_adjustments, balances, ... | string | Specifies whether the `Balance Adjustment` increases or decreases the account balance. Acceptable values: - `TOP_UP` - Adds funds to the balance (e.g., a deposit or manual funding). | authentication.type, credential_on_file.type, daily_rule_configuration.type, maximum_transaction_amount.type, monthly_rule_configuration.type, onboarding_data.payment_instruments.type, recipient_details.type, rule_configuration.type, type |
| unreferenced_refund_manual_entry_enabled | merchants | boolean | Indicates if merchant is allowed to process unreferenced refunds initiated through manual card entry on Finix terminals. | unreferenced_refund_manual_entry_enabled |
| unsigned_file | compliance_forms | string | The ID of the `File` resource for the unsigned `Compliance Form` PDF. | files.unsigned_file |
| unsuccessful_return_url | additional_details, additional_details_payout, payout_links, ... | string | A URL to redirect the recipient to if the payout was successful. | additional_details.unsuccessful_return_url, additional_details_payout.unsuccessful_return_url |
| updated_at | application_profiles, authorizations, balance_adjustments, ... | string (date-time) | Timestamp of when the object was last updated. | updated_at |
| url | entity, entity_buyer, files, ... | string | The URL that can be used to upload, download, or view the `File`. | entity.url, entity_buyer.url, onboarding_data.entity.url, url |
| user | applications | string | ID of the `User` resource. | user |
| user_agent | compliance_forms, onboarding_data, onboarding_forms | string | The User-Agent string of the signee's device. | onboarding_data.additional_underwriting_data.amex_marketing_consent.user_agent, pci_saq_a.user_agent |
| user_id | files | string | The ID of the `user` that requested to create this link. | user_id |
| username | webhooks | string | The username that will be used for basic authentication. | authentication.basic.username |
| valid_from | compliance_forms | string (date-time) | The timestamp of when the `Compliance Form` is valid from. This is set to the form's `signed_at` timestamp upon signature. | valid_from |
| valid_until | compliance_forms | string (date-time) | The timestamp of when the `Compliance Form` is valid until. This is set to one year after the form's `signed_at` timestamp upon signature. | valid_until |
| validation_url | payment_instruments | string | A unique validation URL that will be provided by the Apple SDK front-end for every payment. | validation_url |
| verification | merchants | string | ID of the `Verification` that was submitted to verify the `Merchant`. | verification |
| verify_payment_card | payment_instruments | boolean | - Set to **true** to verify card details with the card issuer. - Must be set to **true** to update the CVV or security code of a card. | verify_payment_card |
| version | compliance_forms, devices | string | The version of the `Compliance Form`. | payment_app.version, version |
| visa_acquirer_processing_fixed_fee | fee_profiles | integer | Applies to all U.S.-based credit card authorizations acquired in the U.S., regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee w... | visa_acquirer_processing_fixed_fee |
| visa_assessments_basis_points | fee_profiles | integer | Applies to all U.S.-based credit card authorizations acquired in the U.S., regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee w... | visa_assessments_basis_points |
| visa_base_II_credit_voucher_fixed_fee | fee_profiles | integer | Applies to all U.S.-based refunds. | visa_base_II_credit_voucher_fixed_fee |
| visa_base_II_system_file_transmission_fixed_fee | fee_profiles | integer | Applies to all Visa transactions and is charged in addition to other transaction-based assessments. | visa_base_II_system_file_transmission_fixed_fee |
| visa_basis_points | fee_profiles | integer | Percentage-based fee incurred against the full amount of each Visa `Transfer`. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%) | visa_basis_points |
| visa_charge_dues_assessments | fee_profiles | integer | A fee associated with Visa's assessment of dues or ongoing charges for services provided through the Visa payment network. | visa_charge_dues_assessments |
| visa_charge_interchange | fee_profiles | boolean | Set to `true` to incur interchange fees for Visa `Transfers`. | visa_charge_interchange |
| visa_credit_voucher_fixed_fee | fee_profiles | integer | Applies to Visa refunds. | visa_credit_voucher_fixed_fee |
| visa_fixed_fee | fee_profiles | integer | Fee in cents incurred for each individual Visa `Transfer`. | visa_fixed_fee |
| visa_kilobyte_access_fixed_fee | fee_profiles | integer | Charged on each authorization transaction submitted to Visa’s network for settlement. | visa_kilobyte_access_fixed_fee |
| vision_amount | additional_healthcare_data, authorizations, transfers | integer | The vision/optical amount for the transaction. | additional_healthcare_data.vision_amount |
| void_me | authorizations | boolean | Set to **True** to void the `Authorization`. | void_me |
| void_state | authorizations | string | Details if the `Authorization` has been voided. | void_state |
| volume_distribution_by_business_type | additional_underwriting_data, identities, onboarding_data, ... | object | Merchant's distribution of credit card volume by business type. Sum of `volume_distribution_by_business_type` must be 100. | additional_underwriting_data.volume_distribution_by_business_type, onboarding_data.additional_underwriting_data.volume_distribution_by_business_type |
| volume_limit | disbursement_rules | integer | The volume limit for disbursements. | ach_velocity.daily_velocity.volume_limit, rule.volume_limit, velocity.volume_limit |
| window_reset | disbursement_rules | string (date-time) | The date and time when the usage window resets. | ach_velocity.daily_velocity.window_reset, velocity.window_reset |
| wire_details | balances | object | Wire transfer details, if applicable. | wire_details |
| year | additional_purchase_data, applications, authorizations, ... | integer | Year of purchase (4-digit). | additional_purchase_data.order_date.year, entity.dob.year, entity.incorporation_date.year, entity_buyer.dob.year, entity_buyer.incorporation_date.year, next_billing_date.year, onboarding_data.entity.dob.year, onboarding_data.entity.incorporation_date.year |