Auto-generated from OpenAPI spec YAML files. Do not edit manually. Last updated: 2026-03-05
Total unique enums: 173
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| address_verification | NOT_SUPPORTED, NO_ADDRESS, NO_MATCH, POSTAL_CODE_AND_STREET_MATCH, POSTAL_CODE_MATCH, STREET_MATCH, UNKNOWN | payment_instruments, transfers | string | - Details the results of verifying address with the issuing bank. - Set to UNKNOWN when address gets updated. |
| allowed_payment_methods | APPLE_PAY, BANK_ACCOUNT, GOOGLE_PAY, PAYMENT_CARD | checkout_forms, payment_links, subscription_links | array[string] | The allowed payment methods. |
| amount_type | FIXED, VARIABLE | 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... |
| attempt_bank_account_validation_check | BUSINESS_CHECKING, BUSINESS_SAVINGS, CHECKING, CORPORATE, CORP_SAVINGS, PERSONAL_CHECKING, PERSONAL_SAVINGS, SAVINGS | onboarding_data, onboarding_forms | string | |
| billing_interval | DAILY, MONTHLY, QUARTERLY, WEEKLY, YEARLY | subscription_links, subscriptions | string | How often the buyer is billed. |
| business_type | ASSOCIATION_ESTATE_TRUST, CORPORATION, GENERAL_PARTNERSHIP, GOVERNMENT_AGENCY, INDIVIDUAL_SOLE_PROPRIETORSHIP, INTERNATIONAL_ORGANIZATION, JOINT_VENTURE, LIMITED_LIABILITY_COMPANY, ... (+3 more) | applications, entity, identities, ... | string | Include the value that best applies to the merchant. |
| business_type | ASSOCIATION_ESTATE_TRUST, CORPORATION, GOVERNMENT_AGENCY, INDIVIDUAL_SOLE_PROPRIETORSHIP, INTERNATIONAL_ORGANIZATION, LIMITED_LIABILITY_COMPANY, PARTNERSHIP, TAX_EXEMPT_ORGANIZATION | onboarding_data, onboarding_forms | string | Include the value that best applies to the merchant. |
| collection_method | BILL_AUTOMATICALLY | subscription_links, subscriptions | string | The method by which subscription payments are collected. At this time, only BILL_AUTOMATICALLY is supported. |
| country | ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ... (+241 more) | address, applications, authorizations, ... | string | The Merchant's country. |
| country | CAN, USA | merchants, onboarding_data, onboarding_forms | string | Country of the Merchant's business |
| created_via | API | created_via, payment_instruments | string | The method by which the resource was created. |
| currency | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, ... (+171 more) | authorizations, balances, checkout_forms, ... | string | ISO 4217 3-letter currency code. |
| currency | CAD, USD | merchants, subscription_links, subscriptions | string | ISO 4217 3-letter currency code. |
| entity_type | PAYMENT_LINK | payment_links, transfer_attempts | string | The type of entity that initiated the Delivery Attempt. |
| entry_mode | CHIP_ENTRY, CONTACTLESS, MANUAL_KEY_ENTRY, SWIPED, UNKNOWN | 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. |
| gateway | DATACAP_V1, TRIPOS_CLOUD_V1, TRIPOS_MOBILE_V1 | identities, merchants | string | Name of the gateway that routes the Merchant's transactions to the processor. |
| interval_type | DAY, MONTH, WEEK, YEAR | subscription_links, subscriptions | string | The unit of time for the trial period. |
| linked_type | MERCHANT | compliance_forms, gateway_integrations, subscription_links, ... | string | Type of the resource to which the Compliance Form belongs. |
| model | D135, PAX_A800, PAX_A920PRO | devices, merchants, model | string | The model type of the Device. |
| operation_key | CARD_PRESENT_SALE, CARD_PRESENT_UNREFERENCED_REFUND, MERCHANT_CREDIT_ADJUSTMENT, MERCHANT_DEBIT_ADJUSTMENT, PULL_FROM_CARD, PUSH_TO_CARD, SALE, UNREFERENCED_REFUND | operation_key, transfer_attempts | string | Details the operation that's performed in the transaction. |
| ownership_type | PRIVATE, PUBLIC | entity, entity_buyer, identities, ... | string | Values can be either: PUBLIC to indicate a publicly-traded company. PRIVATE for privately-held businesses. |
| payment_frequency | ONE_TIME, RECURRING | payment_links, transfer_attempts | string | Whether the Payment Link is one-time only or recurring. Currently, only ONE_TIME is supported. |
| price_type | PROMOTIONAL, REGULAR | authorizations, checkout_forms, payment_links, ... | string | Whether the price is on-sale (PROMOTIONAL) or the normal price (REGULAR). |
| processor | DUMMY_V1, FINIX_V1 | balance_adjustments, transfers | string | The payment processing entity responsible for handling transactions, fund movements, etc., between different financial accounts. |
| prompt_for_signature | ALWAYS, NEVER, ON_NETWORK_RECOMMENDATION, ON_THRESHOLD_AMOUNT | device_configuration, devices, merchants | string | Determines when the terminal prompts for an e-signature. - ALWAYS: The terminal will always request an e-signature. |
| rail | ACH | balance_adjustments, settlements | string | The method of adjustment. |
| refund_policy | MERCHANDISE_EXCHANGE_ONLY, NO_REFUNDS, OTHER, WITHIN_30_DAYS | additional_underwriting_data, identities, onboarding_data, ... | string | Include the value that best applies to the merchant's refund policy. |
| security_code_verification | MATCHED, UNKNOWN, UNMATCHED | payment_instruments, transfers | string | Details the results of the Card Verification Code check. |
| state | FAILED, PENDING, SUCCEEDED | gateway_integrations, settlements, transfer_attempts, ... | string | The state of the Gateway Integration. The possible values are: - PENDING: The Gateway Integration is being processed. |
| state | ACTIVE, COMPLETED, DEACTIVATED, EXPIRED | payment_links, subscription_links | string | The current state of the Subscription Link. |
| type | BANK_ACCOUNT | onboarding_data, onboarding_forms, payment_instruments | string | Type of Payment Instrument. |
| type | EMAIL, PRINT, SMS | additional_details, authorizations, payment_links, ... | string | The type of delivery method used. |
| type | BUSINESS, PERSONAL | identities, transfer_attempts | string | Whether the recipient is considered "PERSONAL" or a "BUSINESS". |
| type | RECURRING, UNSCHEDULED | authorizations, transfers | string |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| operation_key | AUTHORIZATION, CARD_PRESENT_AUTHORIZATION | authorizations | string | Details the operation that's performed in the authorization. |
| state | CANCELED, FAILED, PENDING, SUCCEEDED, UNKNOWN | authorizations | string | The state of the Authorization. |
| state | CANCELED, FAILED, PENDING, SUCCEEDED | authorizations | string | Filter by transaction state. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| currency | USD | balance_adjustments | string | ISO 4217 3 letter currency code. |
| processor | DUMMY_V1 | balance_adjustments | string | The payment processing entity responsible for handling transactions, fund movements, etc., between different financial accounts. |
| state | FAILED, RETURNED, SUBMITTED, SUCCEEDED | balance_adjustments | string | The status of the Balance Adjustment, indicating whether the adjustment was successful or failed. - SUBMITTED - The balance adjustment has been initiated but is not yet confirmed. |
| type | TOP_UP | balance_adjustments | 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). |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| entity_type | BALANCE_ADJUSTMENT, TRANSFER | balances | string | The resource type that caused the change to the Balance. |
| linked_type | APPLICATION | balances | string | Specifies the type of resource identified in linked_to. |
| state | FAILED, PENDING, RETURNED, SUCCEEDED | balances | string | The current state of the Balance Entry. - SUCCEEDED: The balance entry has been successfully posted and affects the account balance. |
| type | DISBURSEMENT | balances | string | The type of transactions stored/ledgered on the Balance. |
| type | BALANCE_TOP_UP_ACH, BALANCE_WITHDRAWAL_ACH, MANUAL_BALANCE_ADJUSTMENT_DECREASE, MANUAL_BALANCE_ADJUSTMENT_INCREASE, PULL_FROM_ACH, PULL_FROM_CARD, PULL_FROM_SAME_DAY_ACH, PUSH_TO_ACH, ... (+2 more) | balances | string | The transaction type that caused a change to the Balance. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| state | COMPLETE, EXPIRED, INCOMPLETE, INVALID, OVERDUE | compliance_forms | string | The state of the Compliance Form. |
| type | PCI_SAQ_A | compliance_forms | string | The type of the Compliance Form. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| action | ACTIVATE | devices | string | The action you want to perform on the device. Use ACTIVATE to activate a the physical model with the Device. |
| action | CANCEL | devices | string | The action you want to perform on the device. Use CANCEL to cancel any active transaction and return to the idle screen. |
| action | DEACTIVATE | devices | string | The action you want to perform on the device. Use DEACTIVATE to deactivate the device. |
| action | CREATE_IDLE_MESSAGE | devices | string | The action you want to perform on the device. Use CREATE_IDLE_MESSAGE to set an idle message on the device. |
| action | REBOOT | devices | string | The action you want to perform on the device. Use REBOOT to restart the device. |
| connection | CLOSED, OPEN | devices | string | Whether the device is available to communicate with Finix Server. |
| connectivity_network_type | CELLULAR, ETHERNET, WIFI | devices | string | Query based on the type of network connection (e.g., Wi-Fi, cellular, ethernet). |
| connectivity_signal_strength | EXCELLENT, GOOD, POOR, VERY_POOR | devices | string | Query based on the network connection strength. |
| event_type | APP_BACKGROUNDED, APP_OPENED, CHARGE_STATUS, SCHEDULED_INTERVAL, SERVER_CONNECTED, USER_INITIATED | devices | string | The type of event that triggered the generation of the Device Metric log. |
| network_type | CELLULAR, ETHERNET, WIFI | devices | string | The type of network connection (e.g., Wi-Fi, cellular, ethernet). |
| payment_app_state | BACKGROUND, FOREGROUND | devices | string | Query based on whether the payment application was running in the background or foreground on the device. |
| prompt_signature | ALWAYS | devices | string | When to prompt for a signature. |
| signal_strength | EXCELLENT, GOOD, POOR, VERY_POOR | devices | string | The network connection strength. |
| state | BACKGROUND, FOREGROUND | devices | string | Whether the payment application is running in the background or foreground on the device. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| day | ALL | disbursement_rules | string | The day of the week the rule applies to. For DAILY rules, only ALL is supported (i.e., the rule applies to all days). |
| linked_type | APPLICATION, PLATFORM | disbursement_rules | string | The type of the resource that is specified in the linked_to field. |
| time_frame | DAILY | disbursement_rules | string | How often the rule resets. For this schema, always DAILY. |
| time_frame | MONTHLY | disbursement_rules | string | How often the rule resets. For this schema, always MONTHLY. |
| time_frame | DAILY, MONTHLY | disbursement_rules | string | How often the rule resets: DAILY or MONTHLY. |
| type | TOTAL | disbursement_rules | string | The type will always be TOTAL. |
| type | TIME_RANGE | disbursement_rules | string | The type of rule configuration. TIME_RANGE rules reset based on a time frame. |
| type | GLOBAL | disbursement_rules | string | The type of rule configuration. For this schema, always GLOBAL. |
| type | GLOBAL, TIME_RANGE | disbursement_rules | string | The type of rule configuration. TIME_RANGE rules reset based on a time frame, while GLOBAL rules apply universally. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| rounding_mode | AGGREGATE, TRANSACTION | 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). |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| category | DUES_AND_ASSESSMENTS, INTERCHANGE, PROCESSOR, THIRD_PARTY_SERVICE_PROVIDER | fees | string | The Fee category. |
| fee_subtype | APPLICATION_FEE, CUSTOM, PLATFORM_FEE | fees | string | The subtype of the Fee. |
| fee_subtype | CUSTOM | fees | string | Subtype of the fee. Set to CUSTOM. |
| fee_type | ACH_BASIS_POINTS, ACH_CREDIT_RETURN_FIXED_FEE, ACH_DEBIT_RETURN_FIXED_FEE, ACH_FIXED, ACH_MAX_FIXED, ACH_NOTICE_OF_CHANGE_CREDIT_FIXED, ACH_NOTICE_OF_CHANGE_DEBIT_FIXED, AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS, ... (+77 more) | fees | string | The type of Fee. Finix may return more enums than those provided. |
| fee_type | CUSTOM | fees | string | The type of the fee. Must be set to CUSTOM. |
| linked_type | AUTHORIZATION, TRANSFER | fees | string | The type of entity the Fee is linked to. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| status | INVALID, PENDING, REQUIRES_UPLOAD, UPLOADED | files | string | The file's upload status. |
| type | DOWNLOAD, UPLOAD, VIEW | files | string | Sets whether the link uploads or downloads files from Finix. |
| type | BANK_STATEMENT, BANK_STATEMENT_ONE_MONTH, BANK_STATEMENT_THREE_MONTHS, BUSINESS_ADDRESS_DOCUMENT, BUSINESS_ADDRESS_VERIFICATION, BUSINESS_INCORPORATION_DOCUMENT, BUSINESS_OWNERSHIP_STRUCTURE, BUSINESS_REGISTRATION, ... (+19 more) | files | string | The type of document. Finix may return more enums than those provided. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| type | CYBERSOURCE | gateway_integrations | string | The type of Gateway Integration to create. At this time, the only supported value is CYBERSOURCE. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| identity_roles | APPLICATION_OWNER, BENEFICIAL_OWNER, BUYER, PLATFORM_OWNER, RECIPIENT, SELLER, SENDER | identities | array[string] | The set of roles available to the Identity. If none is provided, the Identity will be assigned BUYER. |
| identity_roles | BUYER | identities | array[string] | The set of roles available to the Identity. |
| identity_roles | RECIPIENT | identities | array[string] | The set of roles available to the Identity. |
| identity_roles | SELLER | identities | array[string] | The set of roles available to the Identity. |
| processor | DUMMY_V1, FINIX_V1, LITLE_V1, MASTERCARD_V1, NMI_V1, VANTIV_V1, VISA_V1 | identities | string | Set the acquiring processor. Use DUMMY_V1 or null for your Sandbox. |
| type | PERSONAL | identities | string | The Identity type. |
| type | BUSINESS | identities | string | The type of recipient. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| currencies[] | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, ... (+171 more) | merchants | string | ISO 4217 3-letter currency code. |
| fee_ready_to_settle_upon | CONFIGURABLE_WINDOW, PROCESSOR_WINDOW, RECONCILIATION, SUCCESSFUL_CAPTURE | merchants | string | Details how the Merchant settles fees. |
| identity_role | APPLICATION_OWNER, RECIPIENT, SELLER | merchants | string | Filter by the identity_roles of the Merchant's identity. |
| onboarding_state | APPROVED, PROVISIONING, REJECTED, UPDATE_REQUESTED | merchants | string | Details the state of the Merchant's onboarding. |
| processor_type | DUMMY_V1, FINIX_V1, LITLE_V1, VANTIV_V1 | merchants | string | Filter by the Merchant's processor. |
| ready_to_settle_upon | CONFIGURABLE_WINDOW, PROCESSOR_WINDOW, RECONCILIATION, SUCCESSFUL_CAPTURE | merchants | string | Details how transactions captured by the Merchant are settled. |
| ready_to_settle_upon_delay_alignment | ACH, NONE | 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: -... |
| reason | CHURNED, FRAUD, IDENTITY_THEFT | merchants | string | The reason for termination. |
| settlement_funding_identifier | MID_AND_DATE, MID_AND_MERCHANT_NAME, UNSET | 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_queue_mode | MANUAL, UNSET | 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 ... |
| terminated_by | PARTNER_USER, PLATFORM_USER | 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. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| status | COMPLETED, IN_PROGRESS, UPDATE_REQUESTED | onboarding_forms | string | Status of the onboarding_form. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| finix-apiuser-role | ROLE_ADMIN, ROLE_MERCHANT, ROLE_PARTNER, ROLE_PLATFORM | parameters | string | This response header indicating the role of the user who sent the API request. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| account_type | CHECKING, SAVINGS | payment_instruments | string | The bank account type. |
| account_type | BUSINESS_CHECKING, BUSINESS_SAVINGS, PERSONAL_CHECKING, PERSONAL_SAVINGS | payment_instruments | string | The type of bank account. Use the following respective enum when creating a Payment Instrument for: PERSONAL_CHECKING: A personal checking account. |
| bank_account_validation_check | INCONCLUSIVE, INVALID, NOT_ATTEMPTED, VALID | 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... |
| brand | AMERICAN_EXPRESS, CHINA_T_UNION, CHINA_UNION_PAY, DANKORT, DINERS_CLUB, DINERS_CLUB_INTERNATIONAL, DISCOVER, INSTAPAYMENT, ... (+13 more) | payment_instruments | string | The brand of the card saved in the Payment Instrument. |
| card_type | CREDIT, DEBIT, HSA_FSA, NON_RELOADABLE_PREPAID, RELOADABLE_PREPAID, UNKNOWN | payment_instruments | string | The type of payment card saved in the Payment Instrument. |
| country | CAN | payment_instruments | string | The 3-letter country code. |
| currency | CAD | payment_instruments | string | The ISO 4217 3-letter currency code. |
| disabled_code | CARD_ACCOUNT_CLOSED, INVALID_ACCOUNT_NUMBER, LOST_OR_STOLEN_CARD, NON_RELOADABLE_INSUFFICIENT_FUNDS, PICK_UP_CARD, RESTRICTED_CARD, USER_INITIATED | payment_instruments | string | A code indicating why the Payment Instrument was disabled. This field is populated when the card is automatically disabled for reasons other than USER INITIATED or when manually disabled by a u... |
| instrument_type | BANK_ACCOUNT | payment_instruments | string | The type of Payment Instrument. |
| instrument_type | PAYMENT_CARD, TOKEN | payment_instruments | string | The type of Payment Instrument. |
| issuer_country | ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ... (+243 more) | payment_instruments | 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. |
| network_token_state | ACTIVE, CLOSED, FAILED, NOT_ENABLED, PENDING, SUSPENDED | 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... |
| payload_type | DESTINATION, SOURCE | payment_instruments | string | |
| payment_instrument_type | PAYMENT_CARD | payment_instruments | string | The type of Payment Instrument that triggered this Instrument History Entry. |
| processor | DUMMY_V1, FINIX_V1, MASTERCARD_V1, VISA_V1 | payment_instruments | string | The acquiring processor. Use DUMMY_V1 to use your sandbox. |
| third_party | PLAID | payment_instruments | string | A third-party service that allows for connecting to a bank account. |
| type | CONTACT_CARDHOLDER, FRAUD_REPORTED, NOT_FOUND, NUMBER_AND_EXPIRATION_UPDATED, NUMBER_UPDATED | payment_instruments | string | A label indicating the type of update applied to the Payment Instrument. The following enums are possible: - CONTACT_CARDHOLDER: The cardholder has opted out of the service. |
| type | APPLE_PAY, GOOGLE_PAY, PAYMENT_CARD, TOKEN | payment_instruments | string | Type of Payment Instrument. |
| type | PAYMENT_CARD | payment_instruments | string | Type of Payment Instrument. |
| type | APPLE_PAY | payment_instruments | string | Type of Payment Instrument. |
| type | GOOGLE_PAY | payment_instruments | string | Type of Payment Instrument. |
| type | TOKEN | payment_instruments | string | Type of Payment Instrument. |
| type | ALL, BANK_ACCOUNT, PAYMENT_CARD | payment_instruments | string | Filter by the Payment Instrument type. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| state | FAILED, SUCCEEDED | payment_links | string | Whether the delivery attempt succeeded or failed. |
| type | EMAIL, SMS | payment_links | string | The method of delivery. Only EMAIL and SMS are supported. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| allowed_payout_operations | PUSH_TO_ACH, PUSH_TO_CARD | payout_links | array[string] | Defines the types of operations permitted in the payout process when the recipient submits the payout form. |
| state | ACTIVE, AWAITING_PAYOUT, COMPLETED, DEACTIVATED, EXPIRED | payout_links | string | The state of the Payout Link. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| processor_request | DUMMY_V1, FINIX_V1, LITLE_V1, MASTERCARD_V1, NMI_V1, VANTIV_V1, VISA_V1 | processor_request | string | Set the acquiring processor. Use DUMMY_V1 or null for your Sandbox. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| action | RELEASE | settlement_queue_entries | 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... |
| entity_type | ADJUSTMENT, DISPUTE_TRANSFER, FEE, REVERSE, SPLIT_TRANSFER, TRANSFER | settlement_queue_entries | string | The entity the Settlement Queue Entry is linked to. |
| state | AWAITING_SETTLEMENT_TIME, PENDING, RELEASED | settlement_queue_entries | string | The current state of the Settlement Queue Entry. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| action | STOP_ACCRUAL | settlements | string | The action you want to perform on the Settlement. Use STOP_ACCRUAL to close the specified Settlement. |
| entity_type | CUSTOM_FEE, FEE, SPLIT_TRANSFER, TRANSFER | settlements | string | The type of the related entity. |
| fee_category | DUES_AND_ASSESSMENTS, INTERCHANGE, PROCESSOR, THIRD_PARTY_SERVICE_PROVIDER | settlements | string | The category of the fee. |
| parent_entity_type | TRANSFER | settlements | string | The type of the original parent resource where the transaction occurred. This is only populated when sub_type is FEE. |
| status | APPROVED, AWAITING_APPROVAL, PENDING | settlements | string | The status of the Settlement. Merchants only receive payouts when Settlements are APPROVED. |
| subtype | ADJUSTMENT, CREDIT, CUSTOM, DEBIT, DISPUTE, DISPUTE_MERCHANT_CREDIT, DISPUTE_MERCHANT_DEBIT, FEE, ... (+1 more) | settlements | 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. |
| type | APPLICATION, MERCHANT, MERCHANT_REVENUE, NOOP, PARTNER_FEE, PLATFORM, PLATFORM_FEE | settlements | string | The type of Settlement. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| type | DEBIT, DISPUTE_MERCHANT_CREDIT, DISPUTE_MERCHANT_DEBIT | split_transfers | string | The type of Split Transfer. - DEBIT: Standard Split Transfer from a split transaction where the parent Transfer debits the buyer's card. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| state | DEACTIVATED | subscription_links | string | The current state of the Subscription Link. |
| type | MULTIPLE_SUBSCRIPTION_PLANS, SUBSCRIPTION_PLAN | subscription_links | string | The type of Subscription Link. This is very useful for filtering and informing the frontend about the type of Subscription Link. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| canceled_via | AUTOMATED_OVERDUE, MERCHANT, SUPPORT | 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. |
| state | ACTIVE, CANCELED, EXPIRED, NOT_STARTED, PAST_DUE | subscriptions | string | The state of the Subscription. - The NOT_STARTED state occurs when the subscription has not yet started, typically indicated by a start_subscription_at timestamp set during creation. |
| subscription_phase | DISCOUNT, EVERGREEN, FIXED, NONE, TRIAL | 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. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| entity_type | CHECKOUT_FORM | transfer_attempts | string | The type of entity that initiated the Transfer Attempt. |
| entity_type | PAYOUT_LINK | transfer_attempts | string | The type of entity that initiated the Transfer Attempt. |
| type | CREDIT, DEBIT | transfer_attempts | string | Type of Transfer. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| fee_type | ACH_BASIS_POINTS, ACH_CREDIT_RETURN_FIXED_FEE, ACH_DEBIT_RETURN_FIXED_FEE, ACH_FIXED, ACH_MAX_FIXED, ACH_NOTICE_OF_CHANGE_CREDIT_FIXED, ACH_NOTICE_OF_CHANGE_DEBIT_FIXED, AMERICAN_EXPRESS_ASSESSMENT_BASIS_POINTS, ... (+73 more) | transfers | string | Details the type of fee if the Transfer includes a fee. |
| instrument_type | BANK_ACCOUNT, PAYMENT_CARD | transfers | string | Filter by the Payment Instrument's type. |
| operation_key | CARD_NOT_PRESENT_SALE, CARD_PRESENT_AUTHORIZATION, CARD_PRESENT_DEBIT, CARD_PRESENT_SALE, CARD_PRESENT_UNREFERENCED_REFUND, INSTANT_APPLICATION_FUNDING_PULL_FROM_ACH, INSTANT_APPLICATION_FUNDING_PULL_FROM_CARD, INSTANT_APPLICATION_FUNDING_PULL_FROM_FED_NOW, ... (+30 more) | transfers | string | Details the operation that's performed in the transaction. |
| operation_key | CARD_PRESENT_DEBIT, CARD_PRESENT_UNREFERENCED_REFUND, MERCHANT_CREDIT_ADJUSTMENT, MERCHANT_DEBIT_ADJUSTMENT, PULL_FROM_CARD, PUSH_TO_CARD, SALE, UNREFERENCED_REFUND | transfers | string | Details the operation that is be performed in the transaction. |
| operation_key | PUSH_TO_ACH | transfers | string | A key indicating the type of operation. Refer to for an explanation of "Next Day" versus "Same Day" ACH. |
| operation_key | PUSH_TO_SAME_DAY_ACH | transfers | string | A key indicating the type of operation. Refer to for an explanation of "Next Day" versus "Same Day" ACH. |
| operation_key | PUSH_TO_CARD | transfers | string | A key indicating that the operation type should be an card payout. |
| operation_key | CARD_PRESENT_SALE | transfers | string | A key indicating that the operation type should be a card-present sale. |
| operation_key | CARD_PRESENT_UNREFERENCED_REFUND | transfers | string | The operation key for an unreferenced refund. |
| state | CANCELED, FAILED, PENDING, RETURNED, SUCCEEDED, UNKNOWN | transfers | string | The status of the Transfer. |
| state | ALL, CANCELED, FAILED, PENDING, RETURNED, SUCCEEDED | transfers | string | Filter by the transfer's state. |
| subtype | API, APPLICATION_FEE, DISPUTE, MERCHANT_CREDIT, MERCHANT_CREDIT_ADJUSTMENT, MERCHANT_DEBIT, MERCHANT_DEBIT_ADJUSTMENT, PLATFORM_CREDIT, ... (+11 more) | transfers | string | Additional information describing the payment_type. For dispute adjustment transfers (type: DISPUTE): - MERCHANT_DEBIT: Funds are pulled from the merchant(s) when a chargeback occurs. |
| type | ADJUSTMENT, CREDIT, DEBIT, DISPUTE, FEE, RESERVE, REVERSAL, SETTLEMENT, ... (+1 more) | transfers | string | Type of Transfer. |
| type | ALL, CREDIT, DEBIT, REVERSAL, SETTLEMENT | transfers | string | Filter by Transfer type. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| role | ROLE_ADMIN, ROLE_MERCHANT, ROLE_PARTNER, ROLE_PLATFORM | users | string | Details the level of access the User has available. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| card_type | CREDIT, DEBIT, HSA_FSA, RELOADABLE_PREPAID, UNKNOWN, UNRELOADABLE_PREPAID | verifications | string | A code that indicates whether the card is credit, debit, or prepaid. |
| issuer_country | NON_USA, UNKNOWN, USA | verifications | string | The country where the entity (bank or financial institution) that issued the payment instrument (e.g., credit card, debit card) is located. - NON_USA - The card was issued outside of the United S... |
| processor | DUMMY_V1, FINIX_V1, LITLE_V1, VANTIV_V1 | verifications | string | Name of the verification processor. |
| push_to_card_cross_border | FAST_FUNDS, NON_FAST_FUNDS, NOT_SUPPORTED, UNKNOWN | verifications | string | Indicates whether the Payment Instrument supports push-to-card and pull-from-card, cross-border. For more details, see Push to Card. |
| push_to_card_domestic | FAST_FUNDS, NON_FAST_FUNDS, NOT_SUPPORTED, UNKNOWN | verifications | string | Indicates whether the Payment Instrument supports push-to-card and pull-from-card, domestically. For more details, see Push to Card. |
| sub_type | CYBERSOURCE | verifications | string | Specifies the Gateway Integration linked to the Merchant. If the merchant is not linked to a Gateway Integration, this field will be null. |
| type | MERCHANT | verifications | string | Details the type of resource getting verified. |
| type | PAYMENT_INSTRUMENT | verifications | string | Details the type of resource getting verified. |
| Enum Field | Values | Resources | Type | Description |
|---|---|---|---|---|
| type | BASIC, BEARER, NONE | webhooks | string | The type of authentication the webhook will use: - NONE: No authentication will be used. - BASIC: Basic authentication. |