# List Merchants

Retrieve a list of Merchant resources.

Endpoint: GET /merchants
Version: 2022-02-01
Security: BasicAuth

## Header parameters:

  - `Finix-Version` (string)
    Specify the API version of your request. For more details, see Versioning.
    Example: "2022-02-01"

## Query parameters:

  - `after_cursor` (string)
    Return every resource created after the cursor value.

  - `before_cursor` (string)
    Return every resource created before the cursor value.

  - `application_id` (string)
    Filter by Application ID.
    Example: "APc9vhYcPsRuTSpKD9KpMtPe"

  - `country` (string)
    Filter by the Merchant's country (ISO 3166 alpha-3).
    Enum: "USA", "CAN"

  - `currency` (string)
    Filter by the Merchant's currencies (ISO 4217).
    Enum: "USD", "CAD"

  - `created_at.gte` (string)
    Filter where created_at is after the given date.
    Example: "2022-09-27T11:21:23"

  - `created_at.lte` (string)
    Filter where created_at is before the given date.
    Example: "2026-09-27T11:21:23"

  - `id` (string)
    Filter by id.

  - `identity_business_name` (string)
    Filter by the business_name of the Merchant's identity (exact match).
    Example: "finix%20flowers"

  - `identity_business_name.like` (string)
    Filter by the business_name of the Merchant's identity (partial match).
    Example: "finix"

  - `identity_doing_business_as` (string)
    Filter by the doing_business_as of the Merchant's identity (exact match).
    Example: "finix%20flowers"

  - `identity_doing_business_as.like` (string)
    Filter by the doing_business_as of the Merchant's identity (partial match).
    Example: "finix"

  - `identity_first_name` (string)
    Filter by the first_name of the Merchant's identity (exact match).
    Example: "jonathan"

  - `identity_first_name.like` (string)
    Filter by the first_name of the Merchant's identity (partial match).
    Example: "jon"

  - `identity_id` (string)
    Filter by the Merchant's identity.
    Example: "ID6ZC4KedcaCwECQcWr7SM4m"

  - `identity_last_name` (string)
    Filter by the last_name of the Merchant's identity (exact match).
    Example: "williams"

  - `identity_last_name.like` (string)
    Filter by the last_name of the Merchant's identity (partial match).
    Example: "will"

  - `identity_role` (string)
    Filter by the identity_roles of the Merchant's identity.
    Enum: "APPLICATION_OWNER", "RECIPIENT", "SELLER"

  - `mcc` (string)
    Filter by the Merchant's mcc.
    Example: 4900

  - `merchant_name` (string)
    Filter by the Merchant's merchant_name (exact match).
    Example: "finix%20flowers"

  - `merchant_name.like` (string)
    Filter by the Merchant's merchant_name (partial match).
    Example: "finix"

  - `processing_enabled` (boolean)
    Filter by whether the Merchant's processing is enabled (processing_enabled).
    Example: true

  - `processor_type` (string)
    Filter by the Merchant's processor.
    Enum: "FINIX_V1", "DUMMY_V1"

  - `settlement_enabled` (boolean)
    Filter by whether the Merchant's settlements are enabled (settlement_enabled).
    Example: true

  - `limit` (integer)
    The numbers of items to return.
    Example: 10

  - `updated_at.gte` (string)
    Filter where updated_at is after the given date.
    Example: "2022-09-27T11:21:23"

  - `updated_at.lte` (string)
    Filter where updated_at is before the given date.
    Example: "2026-09-27T11:21:23"

  - `verification_id` (string)
    Filter by the Merchant's verification.
    Example: "VI7jopNSiaVMXWKkhxt6dJm7"

## Response 200 fields (application/json):

  - `page` (object)
    Details the page that's returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.next_cursor` (string,null)
    The cursor to use for the next page of results.

  - `_embedded` (object)

  - `_embedded.List of Merchants` (array)

  - `_embedded.List of Merchants.id` (string)
    The ID of the resource.

  - `_embedded.List of Merchants.created_at` (string)
    Timestamp of when the object was created.

  - `_embedded.List of Merchants.updated_at` (string)
    Timestamp of when the object was last updated.

  - `_embedded.List of Merchants.application` (string)
    ID of the Application associated with the resource.

  - `_embedded.List of Merchants.card_cvv_required` (boolean)
    Set to true to require the card's CVV code.

  - `_embedded.List of Merchants.card_expiration_date_required` (boolean)
    Set to true to require the card's expiration date.

  - `_embedded.List of Merchants.card_network_details` (object,null)

  - `_embedded.List of Merchants.convenience_charges_enabled` (boolean)
    Set to true if you want to enable the Merchant to accept convenience fees and/or service fees.

  - `_embedded.List of Merchants.country` (string,null)
    The Merchant's country.
    Enum: "ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP", "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MNP", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB", "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "UMI", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "XKX", "YEM", "ZAF", "ZMB", "ZWE"

  - `_embedded.List of Merchants.creating_transfer_from_report_enabled` (boolean)
    Set to true to automatically create Transfers once settlement reports get generated.

  - `_embedded.List of Merchants.currencies` (array,null)
    ISO 4217 3-letter currency code.
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL"

  - `_embedded.List of Merchants.default_partial_authorization_enabled` (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 have the funds to cover the entire amount on their card.

  - `_embedded.List of Merchants.disbursements_same_day_ach_pull_enabled` (boolean)
    Indicates whether same-day ACH pull disbursements (debits) are enabled, allowing funds to be withdrawn from an account via same-day ACH transfer.

  - `_embedded.List of Merchants.disbursements_same_day_ach_push_enabled` (boolean)
    Indicates whether same-day ACH push disbursements (credits) are enabled, allowing funds to be sent to an account via same-day ACH transfer.

  - `_embedded.List of Merchants.fee_ready_to_settle_upon` (string)
    Details how the Merchant settles fees.
    Enum: "RECONCILIATION", "SUCCESSFUL_CAPTURE", "PROCESSOR_WINDOW", "CONFIGURABLE_WINDOW"

  - `_embedded.List of Merchants.first_approved_at` (string,null)
    This field shows the timestamp when the Merchant was first approved. If the Merchant has not been approved yet, the value is null.

  - `_embedded.List of Merchants.gross_settlement_enabled` (boolean)
    Set to true to enable gross settlements.

  - `_embedded.List of Merchants.identity` (string)
    The ID of the Identity resource associated with the Merchant.

  - `_embedded.List of Merchants.instant_payouts_card_push_enabled` (boolean)
    Set to true if you want to allow the merchant to be enabled for settlement instant payouts.

  - `_embedded.List of Merchants.is_terminated` (boolean)
    Set to true to terminate the Merchant. A merchant can only be terminated if its current onboarding_state is APPROVED.

  - `_embedded.List of Merchants.level_two_level_three_data_enabled` (boolean)
    Set to true to enable the Merchant for Level 2 and Level 3 processing. Default value is false.

  - `_embedded.List of Merchants.loan_repayment` (boolean)
    Whether the merchant is able to support loan repayment on the card networks.

  - `_embedded.List of Merchants.mcc` (string,null)
    The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/managing-operations/security-compliance/approved-merchant-category-codes)

  - `_embedded.List of Merchants.merchant_name` (string)
    The legal name saved in the Merchant resource.

  - `_embedded.List of Merchants.merchant_profile` (string)
    Details if a merchant's info was submitted to third-party processors for provisioning.

  - `_embedded.List of Merchants.mid` (string,null)
    MID of the Merchant.

  - `_embedded.List of Merchants.onboarding_state` (string)
    Details the state of the Merchant's onboarding.
    Enum: "APPROVED", "PROVISIONING", "REJECTED", "UPDATE_REQUESTED"

  - `_embedded.List of Merchants.processing_enabled` (boolean)
    Details if transaction processing is enabled for the Merchant. ROLE_PARTNER can only set this value to false.

  - `_embedded.List of Merchants.processor` (string)
    Name of the transaction processor.
    Enum: "FINIX_V1", "DUMMY_V1"

  - `_embedded.List of Merchants.processor_details` (object)
    Additional details specific to the processor.

  - `_embedded.List of Merchants.processor_details.mid` (string)

  - `_embedded.List of Merchants.processor_details.api_key` (string)

  - `_embedded.List of Merchants.ready_to_settle_upon` (string)
    Details how transactions captured by the Merchant are settled.
    Enum: "RECONCILIATION", "SUCCESSFUL_CAPTURE", "PROCESSOR_WINDOW", "CONFIGURABLE_WINDOW"

  - `_embedded.List of Merchants.ready_to_settle_upon_delay_alignment` (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:

- ACH - Align all transactions to match the timing of ACH settlements, so card transactions settle at the same speed as ACH transactions.
- NONE - Default behavior where card transactions settle the next day (T+1) and ACH transactions settle two days later (T+2).
    Enum: "ACH", "NONE"

  - `_embedded.List of Merchants.refunds_disabled` (boolean)
    A value of true disables refunds for the Merchant, including both referenced and unreferenced refunds.

  - `_embedded.List of Merchants.rent_surcharges_enabled` (boolean)
    Set to true if you want to enable a Merchant to accept rent charges.

  - `_embedded.List of Merchants.settlement_enabled` (boolean)
    Details if settlement approvals are enabled for the Merchant. ROLE_PARTNER can only set this value to false.

  - `_embedded.List of Merchants.settlement_funding_identifier` (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.
- MID_AND_DATE: The MID of the Merchant and the date the funding Transfer was submitted (Date is in UTC). e.g MID:12345678-20220225
- MID_AND_MERCHANT_NAME: The MID of the Merchant and the Merchant#name (white spaces will be removed). e.g. MID:12345678-NameOfMerchant

These details appear alongside the seller's payout in their bank account as a description of the deposit.
    Enum: "UNSET", "MID_AND_DATE", "MID_AND_MERCHANT_NAME"

  - `_embedded.List of Merchants.settlement_queue_mode` (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 will have a Settlement Queue Entry.

When a Settlement Queue Entry is created, it will not be placed into Settlement until the Settlement Queue Entry is explicitly released.

Note: We require the release of all settlement queue entries within 30 days of creation.
    Enum: "UNSET", "MANUAL"

  - `_embedded.List of Merchants.surcharges_enabled` (boolean)
    Set to true if you want to enable a Merchant to accept surcharge fees. For more details, see [Buyer Charges](/guides/online-payments/payment-features/buyer-charges).

  - `_embedded.List of Merchants.tags` (object,null)
    Include up to 50 key: value pairs to annotate requests with custom metadata.
- Maximum character length for individual keys is 40.
- Maximum character length for individual values is 500.
(For example, order_number: 25, item_type: produce, department: sales)

  - `_embedded.List of Merchants.termination_details` (object)

  - `_embedded.List of Merchants.termination_details.terminated_at` (string)
    Timestamp indicating when the termination occurred.
    Example: "2024-09-16T13:11:36.72Z"

  - `_embedded.List of Merchants.termination_details.reason` (string)
    The reason for termination.
    Enum: "CHURNED", "COMPLIANCE_VIOLATION", "EXCESSIVE_ACH_RETURNS", "EXCESSIVE_CHARGEBACKS", "FRAUD", "IDENTITY_THEFT", "ILLEGAL_TRANSACTIONS", "INSOLVENCY", "OTHER", "PCI_VIOLATION", "PROCESSOR_MIGRATION", "SUSPECTED_FRAUD", "UNSUPPORTED_BUSINESS_TYPE", "UNUSUAL_ACTIVITY", "VIOLATED_MERCHANT_TERMS_OF_SERVICE"

  - `_embedded.List of Merchants.termination_details.description` (string)
    An explanation that provides context for the termination.

  - `_embedded.List of Merchants.termination_details.terminated_by` (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.
  - If the role is ROLE_PARTNER, it will return PARTNER_USER.
    Enum: "PLATFORM_USER", "PARTNER_USER"

  - `_embedded.List of Merchants.termination_details.terminated_by_user_id` (string)
    The User ID of the user who initiated the termination of the Merchant account.

  - `_embedded.List of Merchants.unreferenced_refund_manual_entry_enabled` (boolean)
    Indicates if merchant is allowed to process unreferenced refunds initiated through manual card entry on Finix terminals.

  - `_embedded.List of Merchants.verification` (string)
    ID of the Verification that was submitted to verify the Merchant.

  - `_embedded.List of Merchants._links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

  - `_embedded.List of Merchants._links.self` (object)
    Link to the resource that was used in the request.

  - `_embedded.List of Merchants._links.self.href` (string)

  - `_embedded.List of Merchants._links.identity` (object)
    Link to the Identity the request was made under.

  - `_embedded.List of Merchants._links.identity.href` (string)

  - `_embedded.List of Merchants._links.verifications` (object)
    Link to the Verification the request was made under.

  - `_embedded.List of Merchants._links.verifications.href` (string)

  - `_embedded.List of Merchants._links.merchant_profiles` (object)
    Link to the merchant_profile the request was made under.

  - `_embedded.List of Merchants._links.merchant_profiles.href` (string)

  - `_embedded.List of Merchants._links.application` (object)
    Link to the Application the request was made under.

  - `_embedded.List of Merchants._links.application.href` (string)

  - `_links` (object)

  - `_links.self` (object)
    Link to the resource that was used in the request.

  - `_links.self.href` (string)

  - `_links.next` (object)
    Link to the next page of entries.

  - `_links.next.href` (string)

## Response 401 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 403 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 406 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.