openapi: 3.0.3
info:
  title: Flute - API Reference Guide
  version: V1
  description: |
    Last updated: 8.20.2026 8:43 AM
  x-logo:
    url: >-
      https://api.redocly.com/registry/assets/aurora-payments---arise-gateway/sample/v1/logo-horizontal.svg
servers:
  - url: https://sandbox.api.flute.com
    description: Sandbox environment
  - url: https://api.flute.com
    description: Production environment
security:
  - Bearer: []
x-tagGroups:
  - name: Flute API Overview
    tags:
      - Getting Started
      - API Suite Fundamentals
  - name: Flute API Reference
    tags:
      - Authorization
      - ACH Transactions
      - Categories
      - Configurations
      - Customers
      - Devices
      - Invoices
      - Invoices Settings
      - Line Items
      - Merchant API Keys
      - Payment Sessions
      - Ping
      - POS Transactions
      - Quick Payments
      - Settlement Batches
      - Subscription
      - Terminals
      - Transactions
      - Transaction Settings
tags:
  - name: Getting Started
    description: >
      The following is an overview for using the Flute API suite and making
      endpoint calls.

      Getting started has the following steps:

      * Creating a Flute Account

      * Developing in the Sandbox Environment

      * Going Live


      ### Creating a Flute Account
        <h1 style="margin-top: -12px; margin-bottom: 4px;"></h1>

      Before using Flute payment capabilities or the Flute API suite, you must
      create a Flute sandbox account.


      All development and testing occurs first in a sandbox account.

      The sandbox account is a fully isolated account that mirrors production
      behavior.

      All transactions, sales, and Flute API endpoints may be made in the
      sandbox.

      However, it does not process real transactions.

      It is used to validate your integration, applications, and workflows
      before going live.


      The account is free, does not require approval, and is self managed.

      Use the following procedure to create the Flute sandbox account and a
      merchant API key.

      The merchant API key is required to generate an API token, used to make
      each call.<br>

      See <a
      href="/docs/getting-started/api-authentication#creating-a-flute-sandbox-account"
      target="_blank" rel="noopener noreferrer">Creating a Flute Account</a>



      ### Developing in the Sandbox Environment

      The sandbox account is a fully isolated account that mirrors production
      behavior.

      It does not process real transactions.

      Use the sandbox for all testing and app development.

      The Flute support team is available with assistance for developing
      workflows and tools.

      Even after going live, it may still be used to develop and test apps.


      ### Going Live

      When your product is ready to be deployed live, the Flute support team
      will work with you to ensure compliance.

      This compliance follows the production readiness checklist.

      It ensures the best and optimal developer, client, and customer
      experience.<br>

      For more information and details about the production readiness checklist,
      <a href="/docs/launch/go-live" target="_blank" rel="noopener
      noreferrer">Production Go-Live Guide</a>.
  - name: Payment Sessions
    description: >-
      <a id="payment-sessions-overview"></a>


      A payment session is an in-progress payment transaction.

      It is a temporary, time-limited context created when a client initiates a
      payment flow.


      It becomes a secure, stateful environment for completing a payment
      transaction.

      Instead of passing sensitive payment data on every request, the payment
      session persists transaction details.

      This includes the amount, currency, payment method, and status.

      It exposes only the payment session identifier to the client.

      This reduces the risk of data exposure.


      The use of a payment session is applicable only to Flute Elements and
      Flute Checkout.

      Some fields may include a note about their use, and specifically for
      Elements and Checkout.


      Conceptually, the following is a common workflow for using a payment
      session.


      * Create the payment session.

      * Connect through Flute Elements or Flute Checkout.

      This may include collect shipping information, selecting a payment method,
      applying discounts or promotions,

      reviewing and confirming the order, authorizing the payment, and capturing
      the funds.

      Many of these individual steps will be transparent to the client when
      using Flute Elements or Flute Checkout.


      At each step, the payment session holds the transaction state.

      This means each step can update the session without resubmitting the full
      transaction data.

      If the client navigates away but later returns or does not complete the
      transaction immediately, the session can be retrieved by its identifier.

      The flow resumed from where it left off.


      The payment session can end in one of the following ways:

      * The transaction is completed.

      Check the status of the transaction for its success.

      See `POST /v2/payment-sessions/{{paymentSessionId}}`, the field `status`.

      * The transaction is canceled.

      The client chooses to not complete the transaction.

      The state of the transaction is saved.

      The client may retrieve the payment session later and continue the
      transaction.

      * The payment session expires or times out.

      When creating a payment session, an expiration date and time can be
      assigned.

      If the transaction is neither completed nor explicitly canceled, the
      payment session cancels itself.

      Like the cancel operation, the state of the transaction is saved.

      The client may retrieve the payment session later and continue the
      transaction.
  - name: Categories
    description: >
      <a id="categories-overview"></a>


      Categories organize the line items used on Flute invoices and catalogs.


      Categories are a supporting structure for the invoicing catalog rather
      than a required one.

      Line items may be assigned to a category.

      A category can also be deleted without deleting the line items that
      reference it.

      Those items simply remain in an empty category rather than being removed.


      Each category returned by the API also reports an item count.

      This gives a quick view of how many line items currently belong to it.

      With that information, a merchant decides to rename, reassign, or delete
      it.


      Each category has:

      * A name, which must be unique within a merchant account

      * An optional default unit type that applies automatically to line items
      created under it.


      The Categories endpoints support listing, creating, updating, and removing
      categories.

      * GET /pay-int-api/categories.

      The list endpoint accepts a search string along with paging and sort
      parameters.

      A merchant catalog with many categories can be filtered to relevant
      results rather than paged through in full.

      * POST /pay-int-api/categories

      * PUT /pay-int-api/categories/{categoryId}

      * DELETE /pay-int-api/categories/{categoryId}
  - name: Configurations
    description: >+
      <a id="configurations-overview"></a>


      Configurations return merchant-level settings.


      These are settings that other endpoints depend on, rather than records a
      merchant creates or edits directly.

      Because these values shape what other endpoints accept, checking this
      configuration first can prevent avoidable errors.

      For example, such as attempting a tip adjustment when `isTipsEnabled` is
      `false`.


      Two endpoints make up this group.

      Both are read-only; there is no way to create, update, or delete a
      configuration through the API itself.


      * GET /pay-api/v1/configurations/contact-infos.

      The contact-infos endpoint returns the merchant's address, phone number,
      and card details, information that can be reused elsewhere, such as when
      creating an invoice.

      * GET /pay-api/v1/configurations/payments.

      The payments endpoint returns the settings that govern how transactions
      are processed for the merchant account.

      This includes whether tipping is enabled, the available currencies, card
      types, and transaction types, and the list of configured payment
      processors, each with its own settlement batch time slots.

      It also reports defaults such as the surcharge rate, cash discount rate,
      and dual pricing rate, along with AVS options and the maximum allowed
      transaction amount.

  - name: Devices
    description: >
      <a id="devices-overview"></a>


      Devices are the mobile phones and tablets merchants register to accept Tap
      to Pay payments.


      Each device record tracks a device name, its last login time, and the API
      key used to activate it.

      A device also carries a Tap to Pay status, which controls whether it can
      process contactless card payments.

      That status moves through five states: Inactive, Requested, Approved,
      Active, and Denied.


      The Devices endpoints support listing devices, registering them, and
      activating Tap to Pay on each one.

      A merchant can list all registered devices or retrieve a single device by
      its identifier.

      Registering a device requires only a device ID and a device name.

      A separate endpoint activates Tap to Pay, and another generates the token
      a device needs to process a transaction.


      * GET /pay-api/v1/devices.

      Lists every device currently registered to the merchant account.

      * GET /pay-api/v1/devices/{deviceId}.

      Retrieves a single device by its identifier.

      * POST /pay-api/v1/devices.

      Creates a new device, or updates an existing one, by device ID.

      * POST /pay-api/v1/devices/{deviceId}/tap-to-pay/activate.

      Activates the Tap to Pay feature on that specific device.

      * POST /pay-api/v1/devices/tap-to-pay/jwt.

      Generates the token a device needs to process a Tap to Pay transaction.
  - name: Invoices
    description: >
      <a id="invoices-overview"></a>


      Invoices represent a billed amount a merchant sends to a customer for
      payment.


      Each invoice moves through a status lifecycle, starting as a Draft the
      merchant can freely edit.

      Publishing an invoice sends it to the customer and locks its status to
      Published.

      From there it can become Paid, Expired, Canceled, ProcessingPayment, or
      Refunded.


      The Invoices endpoints support creating, editing, publishing, and
      collecting payment on an invoice.

      A draft invoice can be updated or deleted, but a published invoice cannot
      be deleted.

      Once published, an invoice can be submitted for card or ACH payment,
      canceled, or marked as paid.

      Additional endpoints send email or SMS notifications, calculate totals,
      and download a PDF copy.


      * GET /pay-int-api/invoices.

      Lists invoices for the current merchant, filtered by the specified query
      parameters.

      * POST /pay-int-api/invoices.

      Creates a new invoice in Draft status.

      * GET /pay-int-api/invoices/{invoiceId}.

      Retrieves a single invoice's details.

      * PUT /pay-int-api/invoices/{invoiceId}.

      Updates a specified invoice.

      * DELETE /pay-int-api/invoices/{invoiceId}.

      Deletes an invoice; published invoices cannot be deleted.

      * POST /pay-int-api/invoices/publish.

      Publishes an invoice, sending it to the customer.

      * POST /pay-int-api/invoices/{invoiceId}/submit.

      Submits an invoice for card payment processing.

      * POST /pay-int-api/invoices/{invoiceId}/ach/submit.

      Submits an invoice for ACH payment processing.

      * PUT /pay-int-api/invoices/{invoiceId}/cancel.

      Cancels a published, unpaid invoice.

      * PUT /pay-int-api/invoices/{invoiceId}/mark-as-paid.

      Marks a published, unpaid invoice as paid.

      * GET /pay-int-api/invoices/{invoiceId}/calculations.

      Retrieves the calculated totals for an invoice.

      * GET /pay-int-api/invoices/{invoiceId}/download-pdf.

      Downloads a PDF copy of the invoice.

      * POST /pay-int-api/invoices/{invoiceId}/send-email-notification.

      Sends the invoice to the customer by email.

      * POST /pay-int-api/invoices/{invoiceId}/send-published-sms-notification.

      Sends the invoice to the customer by SMS.
  - name: Invoices Settings
    description: >
      <a id="invoices-settings-overview"></a>


      Invoice settings hold the merchant-level defaults applied when creating
      and calculating invoices.


      These include the default due date, tax percentage, discount rate,
      shipping fee, and processing fees.

      Settings also record the merchant's chosen payment method type and payment
      processors for invoices.

      A merchant can toggle notifications, permissions, and other behaviors,
      such as staff discount authority.


      The Invoice Settings endpoints support retrieving and updating a
      merchant's settings.

      Both endpoints are scoped to a single merchant, identified by merchantId
      in the path.

      Retrieving settings returns the current defaults; updating them requires
      resending the complete set of fields.

      Unlike Configurations, these values are set per merchant rather than
      returned as fixed platform defaults.


      * GET /pay-int-api/merchants/{merchantId}/invoices/settings.

      Retrieves a merchant's invoice settings.

      * PUT /pay-int-api/merchants/{merchantId}/invoices/settings.

      Updates a merchant's invoice settings.
  - name: Line Items
    description: >
      <a id="line-items-overview"></a>


      Line items are the catalog entries used to build invoices, one per
      billable product or service.


      Each line item has a name, description, SKU, unit price, unit type, and
      tax rate.

      A line item can optionally be assigned to a category to organize the
      catalog.

      Unit types describe how each item is measured, such as by hour, unit, or
      pound.


      The Line Items endpoints support creating, listing, updating, and deleting
      catalog entries.

      The list endpoint accepts a search string and can filter by category or by
      items with no category.

      A separate endpoint retrieves the available unit types a line item can
      reference.

      Deleting a line item removes it from the catalog for future invoices.


      * GET /pay-int-api/line-items.

      Lists line items, filtered by search string, category, or items with no
      category.

      * POST /pay-int-api/line-items.

      Creates a new line item.

      * PUT /pay-int-api/line-items/{lineItemId}.

      Updates a specified line item.

      * DELETE /pay-int-api/line-items/{lineItemId}.

      Deletes a line item.

      * GET /pay-int-api/line-items/unit-types.

      Retrieves the available unit types for line items.
  - name: Ping
    description: >
      <a id="ping-overview"></a>


      Ping is a lightweight endpoint used to confirm that an API credential is
      valid.


      A successful call confirms the request reached the server and the token
      was accepted.

      The response reports whether the request is authenticated and which
      merchant it resolves to.


      The Ping endpoint supports a single health check call.

      A response with a merchantId confirms the API key is valid and requests
      can proceed.

      A missing or null merchantId means the API key, client ID, or client
      secret should be checked.


      * GET /pay-int-api/ping.

      Confirms the request is authenticated and returns the merchant it resolves
      to.
  - name: POS Transactions
    description: >
      <a id="pos-transactions-overview"></a>


      POS Transactions are card-present payments initiated on a semi-integrated
      card terminal.


      Each transaction record tracks its type, amount, and a status that
      reflects the terminal's progress.

      Transaction type is set with a transactionTypeId, covering Authorization,
      Sale, Capture, Void, Refund, and more.

      Status moves through terminal states such as TerminalConnecting,
      TransactionProcessing, and Completed.


      The POS Transactions endpoints support listing, creating, retrieving,
      canceling, and printing a receipt.

      A transaction can only be canceled while it has not yet begun processing
      on the terminal.

      Retrieving a transaction can optionally wait for it to reach a completed
      status before responding.

      A separate endpoint reprints a completed transaction's receipt directly
      from the terminal.


      * GET /pos-api/v1/pos-transactions.

      Lists POS transactions for the merchant.

      * POST /pos-api/v1/pos-transactions.

      Creates a new POS transaction on the terminal.

      * GET /pos-api/v1/pos-transactions/{posTransactionsid}.

      Retrieves a single POS transaction by its identifier.

      * POST /pos-api/v1/pos-transactions/{posTransactionsid}/cancel.

      Cancels a POS transaction before the terminal begins processing it.

      * POST /pos-api/v1/pos-transactions/{posTransactionId}/print.

      Reprints a completed transaction receipt on the terminal.
  - name: Quick Payments
    description: >
      <a id="quick-payments-overview"></a>


      Quick Payments are shareable payment links a merchant sends to a customer
      to collect payment.


      A one-time link can be used once and expires after payment, unlike a
      reusable link.

      A reusable link stays active across multiple payments from different
      customers until deactivated.

      Every link must be activated before a customer can use it, as a security
      feature.


      The Quick Payments endpoints support creating, listing, and retrieving
      both one-time and reusable links.

      Shared endpoints activate a link, deactivate it, and send it to a customer
      by SMS.

      A one-time link also deactivates automatically once the customer completes
      the payment.

      A reusable link stays active until it is manually deactivated or its time
      limit expires.


      * POST /pay-int-api/quick-payments/one-time.

      Creates a one-time payment link.

      * GET /pay-int-api/quick-payments/one-time.

      Lists one-time payment links.

      * GET /pay-int-api/quick-payments/one-time/{quickPaymentId}.

      Retrieves details of a one-time link.

      * POST /pay-int-api/quick-payments/reusable.

      Creates a reusable payment link.

      * GET /pay-int-api/quick-payments/reusable.

      Lists reusable payment links.

      * GET /pay-int-api/quick-payments/reusable/{quickPaymentId}.

      Retrieves details of a reusable link.

      * POST /pay-int-api/quick-payments/{quickPaymentId}/activate.

      Activates a payment link so it can be used.

      * POST /pay-int-api/quick-payments/{quickPaymentId}/deactivate.

      Deactivates a payment link.

      * POST /pay-int-api/quick-payments/{quickPaymentId}/send-sms-notification.

      Sends a payment link to the customer by SMS.
  - name: Settlement Batches
    description: >
      <a id="settlement-batches-overview"></a>


      Settlement batches group transactions together for the transfer of funds
      to the merchant's account.


      Each batch has a status of either Open, while transactions are still being
      added, or Settled.

      A batch moves to Settled once the funds transfer for every transaction in
      it completes.


      The Settlement Batches endpoint lists batches for the merchant, filtered
      by several criteria.

      Results can be filtered by a date range, specific batch IDs, or payment
      processor IDs.

      Results can also be filtered by status, to return only Open or only
      Settled batches.


      * GET /pay-api/v1/settlements/batches.

      Lists batch settlements, filtered by date range, batch ID, payment
      processor, or status.
  - name: Terminals
    description: >
      <a id="terminals-overview"></a>


      Terminals are the physical card readers a merchant uses to accept
      in-person payments.


      Each terminal record includes its serial number, manufacturer, model, and
      delivery status.

      A terminal also reports a connection status and the last time it was seen
      online.


      The Terminals endpoints support listing a merchant's terminals and
      checking a terminal's live status.

      The list endpoint can be filtered by search string, delivery status,
      serial number, manufacturer, or model.

      The status endpoint returns near real-time details, including battery
      level, printer status, and signal strength.

      Limited data may be returned if the terminal's internet connectivity is
      currently poor.


      * GET /pos-api/v1/terminals.

      Lists a merchant's terminals, filtered by search string, delivery status,
      serial number, manufacturer, or model.

      * GET /pos-api/v1/terminals/{terminalId}/status.

      Retrieves a terminal's current connection, battery, and printer status in
      near real-time.
  - name: Merchant API Keys
    description: >
      The partner has the capability to manage API keys for their merchants.

      This includes creating and deleting API keys.


      This is the same managing capability as through the partner panel.

      The partner can manage the API keys for their individual merchants.

      API keys are not interchangeable from among different merchants, even if
      they are each associated with the same partner.

      Merchants cannot use API keys from any other merchant.

      Standalone merchants, those merchants not having associated partners,
      manage their API keys directly.


      An API key is required only if application or account needs to integrate
      with the API suite.

      The number of API keys is determined by the partner or standalone
      merchants.

      For more information about API keys, see <a
      href="/docs/getting-started/api-authentication" target="_blank">Creating
      an API Key</a>.


      The importance of API keys is that they are used to create API tokens,
      needed to make endpoint calls.

      To generate an API token, see <a
      href="#tag/API-Suite-Fundamentals/Generating-an-API-Token">Generating an
      API Token</a>.


      This API group is a collection of endpoints used to manage API keys.

      It can be used for the following:

      * To list available keys, see `GET /pay-api/v1/merchants/tokens`

      * To create an API key, see `POST /pay-api/v1/merchants/tokens`

      * To delete and API key, see `DELETE
      /pay-api/v1/merchants/tokens/{{clientId}}`
  - name: API Suite Fundamentals
    description: >-
      The following sections are general information required for using the
      Flute API suite.


      ### BaseURL Environments

      Flute provides different environments to run endpoints

      <a id="urlbases"></a>


      **Sandbox**<br>

      The sandbox environment is for development and testing.

      No payments, charges, or invoices will be enforced.

      It is a fully isolated account that mirrors production behavior.


      It is used to validate your integration before going live.

      You will work with your Flute support team developing workflows and tools.


      baseURL: `https://sandbox.api.flute.com`


      **Production**<br>

      Use the production environment for deploying the payment system live to
      clients.

      All payments, charges, or invoices will be enforced.


      When your product is ready to be deployed live, the Flute support team
      will work with you to ensure compliance.

      This compliance follows the production readiness checklist.

      It ensures the best and optimal developer, client, and customer
      experience.<br>

      For more information and details about the production readiness checklist,
      see <a href="/docs/launch/go-live" target="_blank" rel="noopener
      noreferrer">Production Go-Live Guide</a>.


      baseURL: `https://api.flute.com`


      **Using the baseURL**<br>

      Use the baseURL instead of the placeholder noted in each endpoint.

      For example, an endpoint may be described as in the endpoint documentation
      as:<br>

      `POST {{baseURL}}/pay-api/v1/customers`


      To make this call in the sandbox environment, use:<br>

      `POST https://sandbox.api.flute.com/pay-api/v1/customers`


      To make this call in the production environment, use:<br>

      `POST https://api.flute.com/pay-api/v1/customers`


      ### Payment Flow
        <h1 style="margin-top: -12px; margin-bottom: 4px;"></h1>
        The following is a generalized workflow.

      #### Approving a Purchase Request

      1) The customer completes their shopping experience on the merchant's
      website by selecting the products or services.
         They navigate to the checkout page on the merchant's website.
      1) They enter their personal and payment information. This could include
      card details, or net banking information.

      1) The merchant's website captures these details, formatting the details
      as needed to conform to Flute payment gateway requirements.

      1) This sensitive data is transmitted by a secure connection (HTTPS) to
      the Flute payment gateway.
         The Flute payment gateway is a service that makes authorization and sale by cards or ACH (automated clearing house, an electronic network used by financial institutions to process direct deposits).
      1) Upon receiving this information, the Flute payment gateway further
      routes this payment data to the processing center, such as TSYS.

      1) This entity communicates with the customer's bank to get authorization
      or denial for the payment.
         The processing center determines if the payment is approved, that is, if there are sufficient funds or credit available in the customer's account.

      #### Acknowledging a Purchase Request

      1) After the transaction is processed, the processing center sends back a
      response to the Flute payment gateway.
         This response includes details of the transaction, such as whether it was approved or declined.
      1) The Flute payment gateway relays this information back to the
      merchant's website.

      1) The merchant's website receives this information and displays a message
      or signal for the customer.
         Depending on whether the transaction was approved or declined, the appropriate message is displayed to the customer.
         For instance:<br>
         If transaction was successful, a confirmation message is shown, usually with a transaction ID and other details.<br>
         If it was declined, the customer is informed and typically asked to try another payment method.

      ### Supported Card Types
        <h1 style="margin-top: -12px; margin-bottom: 4px;"></h1>
        The following credit cards and formats are supported.

      - Diners Club: Card numbers are typically 14 or 16 digits long.

      - Discover: Card numbers are typically 16 digits long.

      - JCB: Card numbers are typically 16 digits long.

      - MasterCard: Card numbers are typically 16 digits long.

      - VISA: Card numbers are typically 13 or 16 digits long.


      ### Flute-Defined Enums
        <h1 style="margin-top: -12px; margin-bottom: 4px;"></h1>
        The following are Flute-defined enumerations and indices used in endpoint fields.

        <details>
      <summary>Account Holder Types</summary>


      | id | name     |

      |----|----------|

      | 1  | Business |

      | 2  | Personal |

      </details>


      <details>

      <summary>Account Types</summary>


      | id | name     |

      |----|----------|

      | 1  | Checking |

      | 2  | Savings  |

      </details>


      <details>

      <summary>Business Categories</summary>


      | id | name                         |

      |----|------------------------------|

      | 1  | WebDeveloper                 |

      | 2  | IndependentSoftwareVendor    |

      | 3  | IndependentSalesOrganization |

      </details>


      <details>

      <summary>Credit Card Types</summary>

      <a id="card-types"></a>


      | id | name            |

      |:--:|-----------------|

      | 1  | Visa            |

      | 2  | MasterCard      |

      | 3  | AmericanExpress |

      | 4  | DinersClub      |

      | 5  | Discover        |

      | 6  | JCB             |

      </details>


      <details>

      <summary>Countries</summary>

      <a id="flute-countries-codes"></a>


      | id  | isoCode | name                                                 |

      |-----|---------|------------------------------------------------------|

      | 1   | US      | United States                                        |

      | 2   | CA      | Canada                                               |

      | 3   | PR      | Puerto Rico                                          |

      | 4   | AF      | Afghanistan                                          |

      | 5   | AX      | Åland Islands                                        |

      | 6   | AL      | Albania                                              |

      | 7   | DZ      | Algeria                                              |

      | 8   | AS      | American Samoa                                       |

      | 9   | AD      | Andorra                                              |

      | 10  | AO      | Angola                                               |

      | 11  | AI      | Anguilla                                             |

      | 12  | AQ      | Antarctica                                           |

      | 13  | AG      | Antigua and Barbuda                                  |

      | 14  | AR      | Argentina                                            |

      | 15  | AM      | Armenia                                              |

      | 16  | AW      | Aruba                                                |

      | 17  | AU      | Australia                                            |

      | 18  | AT      | Austria                                              |

      | 19  | AZ      | Azerbaijan                                           |

      | 20  | BS      | Bahamas                                              |

      | 21  | BH      | Bahrain                                              |

      | 22  | BD      | Bangladesh                                           |

      | 23  | BB      | Barbados                                             |

      | 24  | BY      | Belarus                                              |

      | 25  | BE      | Belgium                                              |

      | 26  | BZ      | Belize                                               |

      | 27  | BJ      | Benin                                                |

      | 28  | BM      | Bermuda                                              |

      | 29  | BT      | Bhutan                                               |

      | 30  | BO      | Bolivia (Plurinational State of)                     |

      | 31  | BQ      | Bonaire, Sint Eustatius and Saba                     |

      | 32  | BA      | Bosnia and Herzegovina                               |

      | 33  | BW      | Botswana                                             |

      | 34  | BV      | Bouvet Island                                        |

      | 35  | BR      | Brazil                                               |

      | 36  | IO      | British Indian Ocean Territory                       |

      | 37  | UM      | United States Minor Outlying Islands                 |

      | 38  | VG      | Virgin Islands (British)                             |

      | 39  | VI      | Virgin Islands (U.S.)                                |

      | 40  | BN      | Brunei Darussalam                                    |

      | 41  | BG      | Bulgaria                                             |

      | 42  | BF      | Burkina Faso                                         |

      | 43  | BI      | Burundi                                              |

      | 44  | KH      | Cambodia                                             |

      | 45  | CM      | Cameroon                                             |

      | 46  | CV      | Cabo Verde                                           |

      | 47  | KY      | Cayman Islands                                       |

      | 48  | CF      | Central African Republic                             |

      | 49  | TD      | Chad                                                 |

      | 50  | CL      | Chile                                                |

      | 51  | CN      | China                                                |

      | 52  | CX      | Christmas Island                                     |

      | 53  | CC      | Cocos (Keeling) Islands                              |

      | 54  | CO      | Colombia                                             |

      | 55  | KM      | Comoros                                              |

      | 56  | CG      | Congo                                                |

      | 57  | CD      | Congo (Democratic Republic of the)                   |

      | 58  | CK      | Cook Islands                                         |

      | 59  | CR      | Costa Rica                                           |

      | 60  | HR      | Croatia                                              |

      | 61  | CU      | Cuba                                                 |

      | 62  | CW      | Curaçao                                              |

      | 63  | CY      | Cyprus                                               |

      | 64  | CZ      | Czech Republic                                       |

      | 65  | DK      | Denmark                                              |

      | 66  | DJ      | Djibouti                                             |

      | 67  | DM      | Dominica                                             |

      | 68  | DO      | Dominican Republic                                   |

      | 69  | EC      | Ecuador                                              |

      | 70  | EG      | Egypt                                                |

      | 71  | SV      | El Salvador                                          |

      | 72  | GQ      | Equatorial Guinea                                    |

      | 73  | ER      | Eritrea                                              |

      | 74  | EE      | Estonia                                              |

      | 75  | ET      | Ethiopia                                             |

      | 76  | FK      | Falkland Islands (Malvinas)                          |

      | 77  | FO      | Faroe Islands                                        |

      | 78  | FJ      | Fiji                                                 |

      | 79  | FI      | Finland                                              |

      | 80  | FR      | France                                               |

      | 81  | GF      | French Guiana                                        |

      | 82  | PF      | French Polynesia                                     |

      | 83  | TF      | French Southern Territories                          |

      | 84  | GA      | Gabon                                                |

      | 85  | GM      | Gambia                                               |

      | 86  | GE      | Georgia                                              |

      | 87  | DE      | Germany                                              |

      | 88  | GH      | Ghana                                                |

      | 89  | GI      | Gibraltar                                            |

      | 90  | GR      | Greece                                               |

      | 91  | GL      | Greenland                                            |

      | 92  | GD      | Grenada                                              |

      | 93  | GP      | Guadeloupe                                           |

      | 94  | GU      | Guam                                                 |

      | 95  | GT      | Guatemala                                            |

      | 96  | GG      | Guernsey                                             |

      | 97  | GN      | Guinea                                               |

      | 98  | GW      | Guinea-Bissau                                        |

      | 99  | GY      | Guyana                                               |

      | 100 | HT      | Haiti                                                |

      | 101 | HM      | Heard Island and McDonald Islands                    |

      | 102 | VA      | Holy See                                             |

      | 103 | HN      | Honduras                                             |

      | 104 | HK      | Hong Kong                                            |

      | 105 | HU      | Hungary                                              |

      | 106 | IS      | Iceland                                              |

      | 107 | IN      | India                                                |

      | 108 | ID      | Indonesia                                            |

      | 109 | CI      | Côte d'Ivoire                                        |

      | 110 | IR      | Iran (Islamic Republic of)                           |

      | 111 | IQ      | Iraq                                                 |

      | 112 | IE      | Ireland                                              |

      | 113 | IM      | Isle of Man                                          |

      | 114 | IL      | Israel                                               |

      | 115 | IT      | Italy                                                |

      | 116 | JM      | Jamaica                                              |

      | 117 | JP      | Japan                                                |

      | 118 | JE      | Jersey                                               |

      | 119 | JO      | Jordan                                               |

      | 120 | KZ      | Kazakhstan                                           |

      | 121 | KE      | Kenya                                                |

      | 122 | KI      | Kiribati                                             |

      | 123 | KW      | Kuwait                                               |

      | 124 | KG      | Kyrgyzstan                                           |

      | 125 | LA      | Lao People's Democratic Republic                     |

      | 126 | LV      | Latvia                                               |

      | 127 | LB      | Lebanon                                              |

      | 128 | LS      | Lesotho                                              |

      | 129 | LR      | Liberia                                              |

      | 130 | LY      | Libya                                                |

      | 131 | LI      | Liechtenstein                                        |

      | 132 | LT      | Lithuania                                            |

      | 133 | LU      | Luxembourg                                           |

      | 134 | MO      | Macao                                                |

      | 135 | MK      | Macedonia (the former Yugoslav Republic of)          |

      | 136 | MG      | Madagascar                                           |

      | 137 | MW      | Malawi                                               |

      | 138 | MY      | Malaysia                                             |

      | 139 | MV      | Maldives                                             |

      | 140 | ML      | Mali                                                 |

      | 141 | MT      | Malta                                                |

      | 142 | MH      | Marshall Islands                                     |

      | 143 | MQ      | Martinique                                           |

      | 144 | MR      | Mauritania                                           |

      | 145 | MU      | Mauritius                                            |

      | 146 | YT      | Mayotte                                              |

      | 147 | MX      | Mexico                                               |

      | 148 | FM      | Micronesia (Federated States of)                     |

      | 149 | MD      | Moldova (Republic of)                                |

      | 150 | MC      | Monaco                                               |

      | 151 | MN      | Mongolia                                             |

      | 152 | ME      | Montenegro                                           |

      | 153 | MS      | Montserrat                                           |

      | 154 | MA      | Morocco                                              |

      | 155 | MZ      | Mozambique                                           |

      | 156 | MM      | Myanmar                                              |

      | 157 | NA      | Namibia                                              |

      | 158 | NR      | Nauru                                                |

      | 159 | NP      | Nepal                                                |

      | 160 | NL      | Netherlands                                          |

      | 161 | NC      | New Caledonia                                        |

      | 162 | NZ      | New Zealand                                          |

      | 163 | NI      | Nicaragua                                            |

      | 164 | NE      | Niger                                                |

      | 165 | NG      | Nigeria                                              |

      | 166 | NU      | Niue                                                 |

      | 167 | NF      | Norfolk Island                                       |

      | 168 | KP      | Korea (Democratic People's Republic of)              |

      | 169 | MP      | Northern Mariana Islands                             |

      | 170 | NO      | Norway                                               |

      | 171 | OM      | Oman                                                 |

      | 172 | PK      | Pakistan                                             |

      | 173 | PW      | Palau                                                |

      | 174 | PS      | Palestine, State of                                  |

      | 175 | PA      | Panama                                               |

      | 176 | PG      | Papua New Guinea                                     |

      | 177 | PY      | Paraguay                                             |

      | 178 | PE      | Peru                                                 |

      | 179 | PH      | Philippines                                          |

      | 180 | PN      | Pitcairn                                             |

      | 181 | PL      | Poland                                               |

      | 182 | PT      | Portugal                                             |

      | 183 | QA      | Qatar                                                |

      | 184 | XK      | Republic of Kosovo                                   |

      | 185 | RE      | Réunion                                              |

      | 186 | RO      | Romania                                              |

      | 187 | RU      | Russian Federation                                   |

      | 188 | RW      | Rwanda                                               |

      | 189 | BL      | Saint Barthélemy                                     |

      | 190 | SH      | Saint Helena, Ascension and Tristan da Cunha         |

      | 191 | KN      | Saint Kitts and Nevis                                |

      | 192 | LC      | Saint Lucia                                          |

      | 193 | MF      | Saint Martin (French part)                           |

      | 194 | PM      | Saint Pierre and Miquelon                            |

      | 195 | VC      | Saint Vincent and the Grenadines                     |

      | 196 | WS      | Samoa                                                |

      | 197 | SM      | San Marino                                           |

      | 198 | ST      | Sao Tome and Principe                                |

      | 199 | SA      | Saudi Arabia                                         |

      | 200 | SN      | Senegal                                              |

      | 201 | RS      | Serbia                                               |

      | 202 | SC      | Seychelles                                           |

      | 203 | SL      | Sierra Leone                                         |

      | 204 | SG      | Singapore                                            |

      | 205 | SX      | Sint Maarten (Dutch part)                            |

      | 206 | SK      | Slovakia                                             |

      | 207 | SI      | Slovenia                                             |

      | 208 | SB      | Solomon Islands                                      |

      | 209 | SO      | Somalia                                              |

      | 210 | ZA      | South Africa                                         |

      | 211 | GS      | South Georgia and the South Sandwich Islands         |

      | 212 | KR      | Korea (Republic of)                                  |

      | 213 | SS      | South Sudan                                          |

      | 214 | ES      | Spain                                                |

      | 215 | LK      | Sri Lanka                                            |

      | 216 | SD      | Sudan                                                |

      | 217 | SR      | Suriname                                             |

      | 218 | SJ      | Svalbard and Jan Mayen                               |

      | 219 | SZ      | Swaziland                                            |

      | 220 | SE      | Sweden                                               |

      | 221 | CH      | Switzerland                                          |

      | 222 | SY      | Syrian Arab Republic                                 |

      | 223 | TW      | Taiwan                                               |

      | 224 | TJ      | Tajikistan                                           |

      | 225 | TZ      | Tanzania, United Republic of                         |

      | 226 | TH      | Thailand                                             |

      | 227 | TL      | Timor-Leste                                          |

      | 228 | TG      | Togo                                                 |

      | 229 | TK      | Tokelau                                              |

      | 230 | TO      | Tonga                                                |

      | 231 | TT      | Trinidad and Tobago                                  |

      | 232 | TN      | Tunisia                                              |

      | 233 | TR      | Turkey                                               |

      | 234 | TM      | Turkmenistan                                         |

      | 235 | TC      | Turks and Caicos Islands                             |

      | 236 | TV      | Tuvalu                                               |

      | 237 | UG      | Uganda                                               |

      | 238 | UA      | Ukraine                                              |

      | 239 | AE      | United Arab Emirates                                 |

      | 240 | GB      | United Kingdom of Great Britain and Northern Ireland |

      | 241 | UY      | Uruguay                                              |

      | 242 | UZ      | Uzbekistan                                           |

      | 243 | VU      | Vanuatu                                              |

      | 244 | VE      | Venezuela (Bolivarian Republic of)                   |

      | 245 | VN      | Viet Nam                                             |

      | 246 | WF      | Wallis and Futuna                                    |

      | 247 | EH      | Western Sahara                                       |

      | 248 | YE      | Yemen                                                |

      | 249 | ZM      | Zambia                                               |

      | 250 | ZW      | Zimbabwe                                             |

      </details>


      <details>

      <summary>Transaction Creator Types</summary>

      <a id="flute-transaction-creator-type"></a>


      | id | name         |

      |----|--------------|

      | 1  | Portal       |

      | 2  | ApiToken     |

      | 3  | Terminal     |

      | 4  | Invoice      |

      | 5  | QuickPayment |

      | 6  | WebComponent |

      | 7  | Subscription |

      | 8  | MobileApp    |

      | 9  | TapToPay     |

      </details>


      <details>

      <summary>MCC Codes</summary>

      <a id="mcc-codes"></a>


      | id  | code |
      description                                                                                                                                                    
      |

      |-----|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|

      | 1   | 5561 | Camper, Recreational and Utility Trailer
      Dealers                                                                                                               
      |

      | 2   | 3658 | New Otani
      Hotels                                                                                                                                               
      |

      | 3   | 3669 | Eldorado Hotel and
      Casino                                                                                                                                      
      |

      | 4   | 3663 | Hoteles El
      Presidente                                                                                                                                          
      |

      | 5   | 3660 | Knights
      Inn                                                                                                                                                    
      |

      | 6   | 3670 | Arcade
      Hotels                                                                                                                                                  
      |

      | 7   | 3667 | Luxor Hotel and
      Casino                                                                                                                                         
      |

      | 8   | 3655 | Scandic
      Hotels                                                                                                                                                 
      |

      | 9   | 3657 | Oberoi
      Hotels                                                                                                                                                  
      |

      | 10  | 3662 | Circus Circus Hotel and
      Casino                                                                                                                                 
      |

      | 11  | 3654 | Loews
      Hotels                                                                                                                                                   
      |

      | 12  | 3652 | Embassy
      Hotels                                                                                                                                                 
      |

      | 13  | 3664 | Flag
      Inns                                                                                                                                                      
      |

      | 14  | 3661 | Metropole
      Hotels                                                                                                                                               
      |

      | 15  | 3651 | Imperial London
      Hotel                                                                                                                                          
      |

      | 16  | 3653 | Penta
      Hotels                                                                                                                                                   
      |

      | 17  | 3666 | Stakis
      Hotels                                                                                                                                                  
      |

      | 18  | 3668 | Maritim
      Hotels                                                                                                                                                 
      |

      | 19  | 3665 | Hampton Inn
      Hotels                                                                                                                                             
      |

      | 20  | 3656 | Sara
      Hotels                                                                                                                                                    
      |

      | 21  | 3659 | Taj Hotels
      International                                                                                                                                       
      |

      | 22  | 8050 | Nursing and Personal Care
      Facilities                                                                                                                           
      |

      | 23  | 8031 | Osteopathic
      Physicians                                                                                                                                         
      |

      | 24  | 8099 | Medical Services Health Practitioners - No Elsewhere
      Classified                                                                                                
      |

      | 25  | 8220 | Colleges, Universities, Professional Schools, and Junior
      Colleges                                                                                              
      |

      | 26  | 7999 | Recreation Services - Not Elsewhere
      Classified                                                                                                                 
      |

      | 27  | 8211 | Elementary and Secondary
      Schools                                                                                                                               
      |

      | 28  | 8062 |
      Hospitals                                                                                                                                                      
      |

      | 29  | 8041 |
      Chiropractors                                                                                                                                                  
      |

      | 30  | 8241 | Correspondence
      Schools                                                                                                                                         
      |

      | 31  | 8049 | Podiatrists and
      Chiropodists                                                                                                                                   
      |

      | 32  | 8021 | Dentists and
      Orthodontists                                                                                                                                     
      |

      | 33  | 8011 | Doctors and Physicians - Not Elsewhere
      Classified                                                                                                              
      |

      | 34  | 8043 | Opticians, Optical Goods and
      Eyeglasses                                                                                                                        
      |

      | 35  | 8071 | Medical and Dental
      Laboratories                                                                                                                                
      |

      | 36  | 7998 | Aquarium, Seaquarium,
      Dolphinariums                                                                                                                            
      |

      | 37  | 7997 | Membership Clubs (Sports, Recreation, Athletic), Country
      Clubs, and Private Golf
      Courses                                                                       
      |

      | 38  | 8042 | Optometrists and
      Ophthalmologists                                                                                                                              
      |

      | 39  | 8111 | Legal Services and
      Attorneys                                                                                                                                   
      |

      | 40  | 3161 | All Nippon
      Airways                                                                                                                                             
      |

      | 41  | 3164 |
      Norontair                                                                                                                                                      
      |

      | 42  | 3171 | Canadian
      Airlines                                                                                                                                              
      |

      | 43  | 3172 | Nation
      Air                                                                                                                                                     
      |

      | 44  | 3159 | PBA-Provincetwn-Bstn
      Air                                                                                                                                       
      |

      | 45  | 3175 | Middle East
      Air                                                                                                                                                
      |

      | 46  | 3174 | JetBlue
      Airways                                                                                                                                                
      |

      | 47  | 3167 | Aero Continente -
      AEROCONTINENTE                                                                                                                               
      |

      | 48  | 3432 | Reserve
      Rent-a-Car                                                                                                                                             
      |

      | 49  | 5099 | Durable Goods Not Elsewhere Classified (Business to
      Business
      MCC)                                                                                              
      |

      | 50  | 5085 | Industrial Supplies Not Elsewhere Classified (Business to
      Business
      MCC)                                                                                        
      |

      | 51  | 5139 | Commercial Footwear (Business to Business
      MCC)                                                                                                                 
      |

      | 52  | 5137 | Men's, Women's and Children's Uniforms (Business to
      Business
      MCC)                                                                                              
      |

      | 53  | 5193 | Florist Suppliers, Nursery Stock & Flowers (Business to
      Business
      MCC)                                                                                          
      |

      | 54  | 5122 | Drugs, Drug Proprietary's, and Druggists'
      Sundries                                                                                                             
      |

      | 55  | 5051 | Metal Service Centers and Offices (Business to Business
      MCC)                                                                                                   
      |

      | 56  | 5211 | Lumber & Building Materials
      Stores                                                                                                                             
      |

      | 57  | 5200 | Home Supply
      Warehouse                                                                                                                                          
      |

      | 58  | 5111 | Stationery, Office Supplies, and Printing and Writing
      Paper                                                                                                    
      |

      | 59  | 5172 | Petroleum and Products (Business to Business
      MCC)                                                                                                              
      |

      | 60  | 5131 | Piece Goods, Notions and Other Dry Goods (Business to
      Business
      MCC)                                                                                            
      |

      | 61  | 5192 | Books, Periodicals and Newspapers (Business to Business
      MCC)                                                                                                   
      |

      | 62  | 5271 | Mobile Home
      Dealer                                                                                                                                             
      |

      | 63  | 5169 | Chemicals and Allied Products Not Elsewhere Classified
      (Business to Business
      MCC)                                                                              
      |

      | 64  | 5065 | Electrical Parts and Equipment (Business to Business
      MCC)                                                                                                      
      |

      | 65  | 5074 | Plumbing and Heating Equipment and Supplies (Business to
      Business
      MCC)                                                                                         
      |

      | 66  | 5261 | Nurseries and Lawn and Garden Supply
      Stores                                                                                                                    
      |

      | 67  | 5251 | Hardware Stores, Equipment Utilities
      Regulated                                                                                                                 
      |

      | 68  | 5094 | Precious Stones, Metals, Watches and Jewelry (Business to
      Business
      MCC)                                                                                        
      |

      | 69  | 5072 | Hardware, Plumbing, Heat Equipment and Supplies (Business
      to Business
      MCC)                                                                                     
      |

      | 70  | 5198 | Paints, Varnishes and Supplies (Business to Business
      MCC)                                                                                                      
      |

      | 71  | 5199 | Non-durable Goods Not Elsewhere Classified (Business to
      Business
      MCC)                                                                                          
      |

      | 72  | 5231 | Glass, Paint, and Wallpaper
      Stores                                                                                                                             
      |

      | 73  | 3640 | Hyatt
      Motels                                                                                                                                                   
      |

      | 74  | 3632 | The
      Phoenician                                                                                                                                                 
      |

      | 75  | 3638 | Howard
      Johnson                                                                                                                                                 
      |

      | 76  | 3641 | Sofitel
      Hotels                                                                                                                                                 
      |

      | 77  | 3650 | Red Roof
      Inns                                                                                                                                                  
      |

      | 78  | 3629 | Dan
      Hotels                                                                                                                                                     
      |

      | 79  | 3649 |
      Radisson                                                                                                                                                       
      |

      | 80  | 3645 | Queens Moat
      Houses                                                                                                                                             
      |

      | 81  | 3639 | Mount Charlotte
      Thistle                                                                                                                                        
      |

      | 82  | 3634 |
      Swissotel                                                                                                                                                      
      |

      | 83  | 3643 | Steigenberger
      Hotels                                                                                                                                           
      |

      | 84  | 3644 |
      EconoLodges                                                                                                                                                    
      |

      | 85  | 3636 | Sarova
      Hotels                                                                                                                                                  
      |

      | 86  | 3637 | Ramada
      Inns                                                                                                                                                    
      |

      | 87  | 3630 | Extended Stay
      Deluxe                                                                                                                                           
      |

      | 88  | 3646 | Swallow
      Hotels                                                                                                                                                 
      |

      | 89  | 3628 | Excalibur Hotel and
      Casino                                                                                                                                     
      |

      | 90  | 3627 | Extended Stay
      America                                                                                                                                          
      |

      | 91  | 3635 | Reso
      Hotel                                                                                                                                                     
      |

      | 92  | 3647 | Husa
      Hotels                                                                                                                                                    
      |

      | 93  | 3633 | Rank
      Hotels                                                                                                                                                    
      |

      | 94  | 3648 | De Vere
      Hotels                                                                                                                                                 
      |

      | 95  | 3631 | Sleep
      Inn                                                                                                                                                      
      |

      | 96  | 3642 |
      Novotel                                                                                                                                                        
      |

      | 97  | 3626 | Studio
      Plus                                                                                                                                                    
      |

      | 98  | 7991 | Tourist Attractions and
      Exhibits                                                                                                                               
      |

      | 99  | 7933 | Bowling
      Alleys                                                                                                                                                 
      |

      | 100 | 7993 | Video Amusement Game
      Supply                                                                                                                                    
      |

      | 101 | 7941 | Commercial Sports, Professional Sports Clubs, Athletic
      Fields, and Sports
      Promoters                                                                            
      |

      | 102 | 7994 | Video Game Arcades and
      Establishments                                                                                                                          
      |

      | 103 | 7992 | Public Golf
      Courses                                                                                                                                            
      |

      | 104 | 7995 | Betting, including Lottery Tickets, Casino Gaming Chips,
      Off- Track Betting, and Wagers at Race
      Track                                                           |

      | 105 | 7996 | Amusement Parks, Circuses, Carnivals, and Fortune
      Tellers                                                                                                      
      |

      | 106 | 3151 | Air
      Laire                                                                                                                                                      
      |

      | 107 | 3130 | Sunworld International
      Airways                                                                                                                                 
      |

      | 108 | 3148 | Air Littoral
      SA                                                                                                                                                
      |

      | 109 | 3146 |
      Luxair                                                                                                                                                         
      |

      | 110 | 3112 | Windward
      Island                                                                                                                                                
      |

      | 111 | 3156 | Go
      Fly                                                                                                                                                         
      |

      | 112 | 3144 | Virgin
      Atlantic                                                                                                                                                
      |

      | 113 | 3129 | Surinam
      Airways                                                                                                                                                
      |

      | 114 | 3125 | Tan
      Airlines                                                                                                                                                   
      |

      | 115 | 3132 | Frontier
      Airlines                                                                                                                                              
      |

      | 116 | 3141 | Seair
      Alaska                                                                                                                                                   
      |

      | 117 | 3106 | Braathens S.A.F.E.
      (Norway)                                                                                                                                    
      |

      | 118 | 3117 | Venezolana Int de
      Aviacion                                                                                                                                     
      |

      | 119 | 3135 | Sudan
      Airlines                                                                                                                                                 
      |

      | 120 | 3131 | VLM
      Air                                                                                                                                                        
      |

      | 121 | 3136 | Qatar
      Air                                                                                                                                                      
      |

      | 122 | 3111 | British
      Midland                                                                                                                                                
      |

      | 123 | 3127 | Taca
      International                                                                                                                                             
      |

      | 124 | 4723 | Package Tour Operators (Germany
      Only)                                                                                                                          
      |

      | 125 | 4815 | Monthly Summary Telephone
      Charges                                                                                                                              
      |

      | 126 | 4829 | Quasi Cash - Money
      Transfer                                                                                                                                    
      |

      | 127 | 4582 | Airports, Flying Fields, and Airport
      Terminals                                                                                                                 
      |

      | 128 | 4899 | Cable, Satellite, and Other Pay Television and Radio
      Services                                                                                                  
      |

      | 129 | 4457 | Boat Rentals and
      Leasing                                                                                                                                       
      |

      | 130 | 4511 | Airlines and Air
      Carriers                                                                                                                                      
      |

      | 131 | 4761 | Telemarketing of Travel Related Services and
      Vitamins                                                                                                          
      |

      | 132 | 4813 | Special Telecom
      Merchant                                                                                                                                       
      |

      | 133 | 5044 | Photographic, Photocopy, Microfilm Equipment and Supplies
      (Business to Business
      MCC)                                                                           
      |

      | 134 | 4468 | Marinas, Marine Service, and
      Supplies                                                                                                                          
      |

      | 135 | 4789 | Transportation Services-not elsewhere
      classified                                                                                                               
      |

      | 136 | 5013 | Motor Vehicle Supplies and New Parts (Business to Business
      MCC)                                                                                                
      |

      | 137 | 5047 | Dental/Laboratory/Medical/Ophthalmic Hospital Equipment and
      Supplies                                                                                           
      |

      | 138 | 5046 | Commercial Equipment Not Elsewhere Classified (Business to
      Business
      MCC)                                                                                       
      |

      | 139 | 5021 | Office Furniture (Business to Business
      MCC)                                                                                                                    
      |

      | 140 | 5039 | Construction Materials Not Elsewhere Classified (Business
      to Business
      MCC)                                                                                     
      |

      | 141 | 4812 | Telecommunication Equipment and Telephone
      Sales                                                                                                                
      |

      | 142 | 5045 | Computers, Computer Peripheral Equipment, and
      Software                                                                                                         
      |

      | 143 | 4784 | Bridge and Road Fees,
      Tolls                                                                                                                                    
      |

      | 144 | 4900 | Utilities-Electric, Gas, Water, and
      Sanitary                                                                                                                   
      |

      | 145 | 4722 | Travel
      Agencies                                                                                                                                                
      |

      | 146 | 4814 | Telecommunication Services, Including Local and Long
      Distance Calls, Credit Card Calls, Call Through Use of
      Magnetic-Strip-Reading Telephones, and Fax Services |

      | 147 | 4821 | Telegraph
      Services                                                                                                                                             
      |

      | 148 | 4816 | Computer Network/Information Services and other Online
      Services such as electronic bulletin board, e-mail, web site hosting
      services, or Internet access        |

      | 149 | 3618 | Great
      Wolf                                                                                                                                                     
      |

      | 150 | 3609 | Gaylord
      Palms                                                                                                                                                  
      |

      | 151 | 3612 | Movenpick
      Hotels                                                                                                                                               
      |

      | 152 | 3611 | C MON
      INN                                                                                                                                                      
      |

      | 153 | 3624 | Lady Luck Hotel and
      Casino                                                                                                                                     
      |

      | 154 | 3608 | Gaylord
      Opryland                                                                                                                                               
      |

      | 155 | 3615 | Travelodge
      Motels                                                                                                                                              
      |

      | 156 | 3623 | Dorint
      Hotels                                                                                                                                                  
      |

      | 157 | 3610 | Gaylord
      Texan                                                                                                                                                  
      |

      | 158 | 3620 | Binion's Horseshoe
      Club                                                                                                                                        
      |

      | 159 | 3617 | America's Best Value
      Inn                                                                                                                                       
      |

      | 160 | 3621 | Extended
      Stay                                                                                                                                                  
      |

      | 161 | 3622 | Merlin
      Hotel                                                                                                                                                   
      |

      | 162 | 3625 | Hotel
      Universale                                                                                                                                               
      |

      | 163 | 3619 |
      Aloft                                                                                                                                                          
      |

      | 164 | 3607 | Fountainebleau
      Resort                                                                                                                                          
      |

      | 165 | 3613 | Microtel Inns &
      Suites                                                                                                                                         
      |

      | 166 | 3614 |
      Americinn                                                                                                                                                      
      |

      | 167 | 3087 | Metro
      Airlines                                                                                                                                                 
      |

      | 168 | 3084 | Eva
      Airlines                                                                                                                                                   
      |

      | 169 | 3099 | Cathay
      Pacific                                                                                                                                                 
      |

      | 170 | 3102 |
      Iberia                                                                                                                                                         
      |

      | 171 | 3103 | Garuda
      (Indonesia)                                                                                                                                             
      |

      | 172 | 3094 | Zambia
      Airways                                                                                                                                                 
      |

      | 173 | 3090 | Uni
      Airways                                                                                                                                                    
      |

      | 174 | 3085 | Midwest Express Airlines,
      Inc                                                                                                                                  
      |

      | 175 | 3089 | Tans
      Saero                                                                                                                                                     
      |

      | 176 | 3105 |
      Piedmont                                                                                                                                                       
      |

      | 177 | 3098 | Asiana
      Airlines                                                                                                                                                
      |

      | 178 | 3096 | Air
      Zimbabwe                                                                                                                                                   
      |

      | 179 | 3097 | Spanair (abbreviation:
      SPANAIR)                                                                                                                                
      |

      | 180 | 3100 | Malaysian Airline
      Sys                                                                                                                                          
      |

      | 181 | 7629 | Electrical and Small Appliance Repair
      Shops                                                                                                                    
      |

      | 182 | 7692 | Welding
      Services                                                                                                                                               
      |

      | 183 | 7549 | Towing
      Services                                                                                                                                                
      |

      | 184 | 7922 | Theatrical Producers (except Motion Pictures) and Ticket
      Agencies                                                                                              
      |

      | 185 | 7778 | Citishare Cash
      Advance                                                                                                                                         
      |

      | 186 | 7542 | Car
      Washes                                                                                                                                                     
      |

      | 187 | 7801 | Government-Licensed Casinos (Online
      Gambling)                                                                                                                  
      |

      | 188 | 7829 | Motion Picture & Video Tape Production and Distribution
      (Business to Business
      MCC)                                                                             
      |

      | 189 | 7623 | Air Conditioning and Refrigeration Repair
      Shops                                                                                                                
      |

      | 190 | 7800 | Government-Owned
      Lotteries                                                                                                                                     
      |

      | 191 | 7932 | Billiards & Pool
      Establishments                                                                                                                                
      |

      | 192 | 7841 | DVD/Video Tape Rental
      Stores                                                                                                                                   
      |

      | 193 | 7929 | Bands, Orchestras & Misc
      Entertainment                                                                                                                         
      |

      | 194 | 7911 | Dance Halls, Studios &
      Schools                                                                                                                                 
      |

      | 195 | 7832 | Motion Picture
      Theater                                                                                                                                         
      |

      | 196 | 7641 | Furniture - Reupholster, Repair, and
      Refinishing                                                                                                               
      |

      | 197 | 7802 | Government-Licensed Horse/Dog
      Racing                                                                                                                           
      |

      | 198 | 7622 | Electronic Repair
      Shops                                                                                                                                        
      |

      | 199 | 7631 | Watch, Clock, and Jewelry Repair
      Shops                                                                                                                         
      |

      | 200 | 7699 | Miscellaneous Repair Shops and Related
      Services                                                                                                                
      |

      | 201 | 4215 | Courier Services-Air and Ground, and Freight
      Forwarders                                                                                                        
      |

      | 202 | 3825 |
      Vdara                                                                                                                                                          
      |

      | 203 | 4011 |
      Railroads                                                                                                                                                      
      |

      | 204 | 3829 | Country Inn by
      Carlson                                                                                                                                         
      |

      | 205 | 3821 | Caribe
      Royale                                                                                                                                                  
      |

      | 206 | 4121 | Taxicabs and
      Limousines                                                                                                                                        
      |

      | 207 | 3828 | Cosmopolitan of Las
      Vegas                                                                                                                                      
      |

      | 208 | 4112 | Passenger Rail
      (train)                                                                                                                                         
      |

      | 209 | 4111 | Local and Suburban Commuter Passenger Transportation,
      including
      Ferries                                                                                        
      |

      | 210 | 3820 | Jumeirah Essex
      House                                                                                                                                           
      |

      | 211 | 4411 | Steamship and Cruise
      Lines                                                                                                                                     
      |

      | 212 | 4119 | Ambulance
      Services                                                                                                                                             
      |

      | 213 | 3827 | Galt
      House                                                                                                                                                     
      |

      | 214 | 3822 |
      Crossland                                                                                                                                                      
      |

      | 215 | 3823 | Grand Sierra
      Resort                                                                                                                                            
      |

      | 216 | 3826 |
      Autograph                                                                                                                                                      
      |

      | 217 | 3824 |
      Aria                                                                                                                                                           
      |

      | 218 | 3830 | Park Plaza
      Hotel                                                                                                                                               
      |

      | 219 | 4131 | Bus Lines, includes Charters/Tour
      Buses                                                                                                                        
      |

      | 220 | 4225 | Public Warehousing-Farm products, Refrigerated Goods,
      Household Goods, and
      Storage                                                                             
      |

      | 221 | 4214 | Motor Freight Carriers and Trucking-Local and Long
      Distance, Moving & Storage Companies, and Local
      Delivery                                                     |

      | 222 | 3819 | Oxford
      Suites                                                                                                                                                  
      |

      | 223 | 3831 |
      Waldorf                                                                                                                                                        
      |

      | 224 | 7230 | Salon, Barber, Beauty, and Nail
      Salon                                                                                                                          
      |

      | 225 | 3606 | Jefferson
      Hotel                                                                                                                                                
      |

      | 226 | 3601 | Trade Winds
      Resorts                                                                                                                                            
      |

      | 227 | 3595 | Hospitality
      Inns                                                                                                                                               
      |

      | 228 | 3599 | Pannonia
      Hotels                                                                                                                                                
      |

      | 229 | 3597 | Riverside Resort and
      Casino                                                                                                                                    
      |

      | 230 | 3596 | Wynn Las
      Vegas                                                                                                                                                 
      |

      | 231 | 3593 | Cunard
      Hotels                                                                                                                                                  
      |

      | 232 | 3604 | Hilton Garden
      Inn                                                                                                                                              
      |

      | 233 | 3594 | Arizona
      Biltmore                                                                                                                                               
      |

      | 234 | 3602 | Hudson
      Hotel                                                                                                                                                   
      |

      | 235 | 3603 | Noah's
      Hotel                                                                                                                                                   
      |

      | 236 | 3600 | Saddlebrook Resort -
      Tampa                                                                                                                                     
      |

      | 237 | 3598 | Regent International
      Hotels                                                                                                                                    
      |

      | 238 | 3605 | Jurys Doyle Hotel
      Group                                                                                                                                        
      |

      | 239 | 3083 | Air
      Afrique                                                                                                                                                    
      |

      | 240 | 3078 | China
      Airlines                                                                                                                                                 
      |

      | 241 | 3077 | Thai
      Airways                                                                                                                                                   
      |

      | 242 | 3073 | Air
      Cal                                                                                                                                                        
      |

      | 243 | 3076 |
      Aeromexico                                                                                                                                                     
      |

      | 244 | 3075 | Singapore
      Airlines                                                                                                                                             
      |

      | 245 | 3070 | Pacific Southwest Airlines
      (PSA)                                                                                                                               
      |

      | 246 | 3069 | Sun Country
      Air                                                                                                                                                
      |

      | 247 | 3072 | CEBU
      PAC                                                                                                                                                       
      |

      | 248 | 3082 | Korean
      Airlines                                                                                                                                                
      |

      | 249 | 3071 | Air British
      Columbia                                                                                                                                           
      |

      | 250 | 3079 | Jetstar Airways -
      Jetstar                                                                                                                                      
      |

      | 251 | 7375 | Information Retrieval Services (Business to Business
      MCC)                                                                                                      
      |

      | 252 | 7524 | Express Payment Service Mechants - Parking Lots and
      Garages                                                                                                    
      |

      | 253 | 7361 | Employment Agencies and Temporary Help
      Services                                                                                                                
      |

      | 254 | 7531 | Automotive Top & Body
      Shops                                                                                                                                    
      |

      | 255 | 7392 | Management, Consulting, and Public Relations
      Services                                                                                                          
      |

      | 256 | 7535 | Automotive Paint
      Shops                                                                                                                                         
      |

      | 257 | 7395 | Photofinishing Laboratories and Photo
      Developing                                                                                                               
      |

      | 258 | 7519 | Motor Home and Recreational Vehicle
      Rentals                                                                                                                    
      |

      | 259 | 7339 | Stenographic
      Service                                                                                                                                           
      |

      | 260 | 7372 | Computer Programming, Data Processing, and Integrated
      Systems Design
      Services                                                                                  
      |

      | 261 | 7513 | Truck and Utility Trailer
      Rentals                                                                                                                              
      |

      | 262 | 7511 | Truck
      Stops                                                                                                                                                    
      |

      | 263 | 7379 | Computer Maintenance, Repair and Services (Business to
      Business
      MCC)                                                                                           
      |

      | 264 | 7534 | Tire Retreading &
      Repair                                                                                                                                       
      |

      | 265 | 7338 | Quick Copy, Reproduction
      Service                                                                                                                               
      |

      | 266 | 7538 | Automotive Service Shops
      (Non-Dealer)                                                                                                                          
      |

      | 267 | 7349 | Cleaning, Maintenance & Janitorial
      Services                                                                                                                    
      |

      | 268 | 7523 | Parking Lots and
      Garages                                                                                                                                       
      |

      | 269 | 7399 | Business
      Services                                                                                                                                              
      |

      | 270 | 7512 | Automobile Rental
      Agency                                                                                                                                       
      |

      | 271 | 7393 | Detective Agencies, Protective Agencies, and Security
      Services, including Armored Cars and Guard
      Dogs                                                           |

      | 272 | 7342 | Exterminating and Disinfecting
      Services                                                                                                                        
      |

      | 273 | 7394 | Equipment, Tool, Furniture, and Appliance Rental and
      Leasing                                                                                                   
      |

      | 274 | 3429 | Insurance
      Rent-a-Car                                                                                                                                           
      |

      | 275 | 3431 | Replacement
      Rent-a-Car                                                                                                                                         
      |

      | 276 | 3427 | Avon
      Rent-a-Car                                                                                                                                                
      |

      | 277 | 3425 | Automate
      Rent-a-Car                                                                                                                                            
      |

      | 278 | 3430 | Major
      Rent-a-Car                                                                                                                                               
      |

      | 279 | 3412 | A-1
      R-A-C                                                                                                                                                      
      |

      | 280 | 3420 | ANSA
      International                                                                                                                                             
      |

      | 281 | 3409 | General
      Rent-a-Car                                                                                                                                             
      |

      | 282 | 3421 | Allstate
      Rent-a-Car                                                                                                                                            
      |

      | 283 | 3423 | Avcar
      Rent-a-Car                                                                                                                                               
      |

      | 284 | 3428 | Carey
      Rent-a-Car                                                                                                                                               
      |

      | 285 | 3405 | Enterprise
      R-A-C                                                                                                                                               
      |

      | 286 | 3797 | Atlantic City
      Hilton                                                                                                                                           
      |

      | 287 | 3788 | Ala Moana Hotel / Ala Moana
      Hotels                                                                                                                             
      |

      | 288 | 3814 | The Roosevelt Hotel
      NY                                                                                                                                         
      |

      | 289 | 3813 | Hotel
      Indigo                                                                                                                                                   
      |

      | 290 | 3802 | The Palace
      Hotel                                                                                                                                               
      |

      | 291 | 3818 | Mainstay
      Suites                                                                                                                                                
      |

      | 292 | 3791 | Staybridge
      Suites                                                                                                                                              
      |

      | 293 | 3796 | Peppermill Hotel
      Casino                                                                                                                                        
      |

      | 294 | 3789 | Smugglers' Notch
      Resort                                                                                                                                        
      |

      | 295 | 3810 | La Costa
      Resort                                                                                                                                                
      |

      | 296 | 3801 | Wilderness Hotel and Golf
      Resort                                                                                                                               
      |

      | 297 | 3793 | The Flamingo
      Hotels                                                                                                                                            
      |

      | 298 | 3807 |
      Element                                                                                                                                                        
      |

      | 299 | 3799 | Hale Koa
      Hotel                                                                                                                                                 
      |

      | 300 | 3790 | Raffles
      Hotels                                                                                                                                                 
      |

      | 301 | 3812 | Hyatt
      Place                                                                                                                                                    
      |

      | 302 | 3817 |
      Affinia                                                                                                                                                        
      |

      | 303 | 3794 | Grand Casino
      Hotels                                                                                                                                            
      |

      | 304 | 3795 | Paris Las Vegas
      Hotel                                                                                                                                          
      |

      | 305 | 3811 | Premier Travel
      Inn                                                                                                                                             
      |

      | 306 | 3800 |
      Homestead                                                                                                                                                      
      |

      | 307 | 3815 | Holiday Inn
      Nickelodeon                                                                                                                                        
      |

      | 308 | 3808 |
      LXR                                                                                                                                                            
      |

      | 309 | 3792 | Claridge Casino
      Hotel                                                                                                                                          
      |

      | 310 | 3798 | Embassy Vacation
      Resort                                                                                                                                        
      |

      | 311 | 3816 | Home2
      Suites                                                                                                                                                   
      |

      | 312 | 3588 | Helmsley
      Hotels                                                                                                                                                
      |

      | 313 | 3584 | Princess Hotels
      International                                                                                                                                  
      |

      | 314 | 3589 | Doral Golf
      Resort                                                                                                                                              
      |

      | 315 | 3586 | Sokos
      Hotels                                                                                                                                                   
      |

      | 316 | 3587 | Doral
      Hotels                                                                                                                                                   
      |

      | 317 | 3590 | Fairmont
      Hotel                                                                                                                                                 
      |

      | 318 | 3585 | Hungar
      Hotels                                                                                                                                                  
      |

      | 319 | 3591 | Sonesta
      Hotels                                                                                                                                                 
      |

      | 320 | 3592 | Omni
      Hotels                                                                                                                                                    
      |

      | 321 | 3068 | AIR
      STANA                                                                                                                                                      
      |

      | 322 | 3064 | Adria
      Airways                                                                                                                                                  
      |

      | 323 | 3058 |
      Delta                                                                                                                                                          
      |

      | 324 | 3054 | Ladeco
      (Chile)                                                                                                                                                 
      |

      | 325 | 3055 | LAB
      (Bolivia)                                                                                                                                                  
      |

      | 326 | 3057 | Virgin America – VIR
      AMER                                                                                                                                      
      |

      | 327 | 3063 | US
      Airways                                                                                                                                                     
      |

      | 328 | 3062 | Hapag-Lloyd Express -
      HLX                                                                                                                                      
      |

      | 329 | 3060 | NWA
      Air                                                                                                                                                        
      |

      | 330 | 3052 |
      LANAIR                                                                                                                                                         
      |

      | 331 | 3053 | AVIACO
      (Spain)                                                                                                                                                 
      |

      | 332 | 3066 |
      Southwest                                                                                                                                                      
      |

      | 333 | 3056 |
      JetAir                                                                                                                                                         
      |

      | 334 | 3059 | DBA Airlines-DBA
      AIR                                                                                                                                           
      |

      | 335 | 3065 | Airinter
      (AirInternational)                                                                                                                                    
      |

      | 336 | 3061 |
      Continental                                                                                                                                                    
      |

      | 337 | 7299 | Miscellaneous Personal Services - Not Elsewhere
      Classified                                                                                                     
      |

      | 338 | 7332 | Blueprinting and Photocopying
      Services                                                                                                                         
      |

      | 339 | 7333 | Commercial Photography, Art, and
      Graphics                                                                                                                      
      |

      | 340 | 7311 | Advertising
      Services                                                                                                                                           
      |

      | 341 | 7298 | Health and Beauty
      Spas                                                                                                                                         
      |

      | 342 | 7276 | Tax Preparation
      Services                                                                                                                                       
      |

      | 343 | 7297 | Massage
      Parlors                                                                                                                                                
      |

      | 344 | 7321 | Consumer Credit Reporting
      Agencies                                                                                                                             
      |

      | 345 | 7277 | Counseling Services - Debt, Marriage, and
      Personal                                                                                                             
      |

      | 346 | 7296 | Clothing Rental - Costumes, Uniforms and Formal
      Wear                                                                                                           
      |

      | 347 | 7278 | Buying and Shopping Services and
      Clubs                                                                                                                         
      |

      | 348 | 3395 | Thrify Car
      Rental                                                                                                                                              
      |

      | 349 | 3398 | Econo Car
      R-A-C                                                                                                                                                
      |

      | 350 | 3389 | Avis
      R-A-C                                                                                                                                                     
      |

      | 351 | 3391 | Europe by
      Car                                                                                                                                                  
      |

      | 352 | 3386 | Showcase Rental
      Cars                                                                                                                                           
      |

      | 353 | 3396 | Tilden
      R-A-C                                                                                                                                                   
      |

      | 354 | 3394 | Kemwell Group
      R-A-C                                                                                                                                            
      |

      | 355 | 3400 | Auto Host Car
      Rentals                                                                                                                                          
      |

      | 356 | 3387 | Alamo Rent a
      Car                                                                                                                                               
      |

      | 357 | 3385 | Tropical
      R-A-C                                                                                                                                                 
      |

      | 358 | 3388 | Merchants Rent-A-Car,
      Inc                                                                                                                                      
      |

      | 359 | 3381 | Europ
      Car                                                                                                                                                      
      |

      | 360 | 3390 | Dollar
      R-A-C                                                                                                                                                   
      |

      | 361 | 3393 | National Car
      Rental                                                                                                                                            
      |

      | 362 | 3772 | Nemacolin
      Woodlands                                                                                                                                            
      |

      | 363 | 3781 | Patricia Grand Resort
      Hotels                                                                                                                                   
      |

      | 364 | 3786 | Ohana Hotel of
      Hawaii                                                                                                                                          
      |

      | 365 | 3775 | Sands
      Resort                                                                                                                                                   
      |

      | 366 | 3778 | Four Points
      Hotels                                                                                                                                             
      |

      | 367 | 3776 | Nevele Grande Resort and Country
      Club                                                                                                                          
      |

      | 368 | 3782 | Rosen Hotels &
      Resort                                                                                                                                          
      |

      | 369 | 3774 | New York-New York Hotel and
      Casino                                                                                                                             
      |

      | 370 | 3767 | Main Street Hotel and
      Casino                                                                                                                                   
      |

      | 371 | 3777 | Mandalay Bay
      Resort                                                                                                                                            
      |

      | 372 | 3770 | SpringHill
      Suites                                                                                                                                              
      |

      | 373 | 3783 | Town and Country Resort and Convention
      Center                                                                                                                  
      |

      | 374 | 3784 | First Hospitality
      Hotel                                                                                                                                        
      |

      | 375 | 3773 | The Venetian Resort Hotel and
      Casino                                                                                                                           
      |

      | 376 | 3787 | Caribe Royale Resort Suites &
      Villas                                                                                                                           
      |

      | 377 | 3785 | Outrigger Hotels and
      Resorts                                                                                                                                   
      |

      | 378 | 3780 | Disney
      Resorts                                                                                                                                                 
      |

      | 379 | 3779 | W
      Hotels                                                                                                                                                       
      |

      | 380 | 3765 |
      Bellagio                                                                                                                                                       
      |

      | 381 | 3769 | Stratosphere Hotel and
      Casino                                                                                                                                  
      |

      | 382 | 3766 | Fremont Hotel and
      Casino                                                                                                                                       
      |

      | 383 | 3768 | Silver Star Hotel and
      Casino                                                                                                                                   
      |

      | 384 | 3771 | Caesar's
      Resort                                                                                                                                                
      |

      | 385 | 3583 | Radisson
      BLU                                                                                                                                                   
      |

      | 386 | 3578 | Frankenmuth
      Bavarian                                                                                                                                           
      |

      | 387 | 3580 | Hotel Del
      Coronado                                                                                                                                             
      |

      | 388 | 3575 | Vagabond
      Hotels                                                                                                                                                
      |

      | 389 | 3576 | La Quinta
      Resort                                                                                                                                               
      |

      | 390 | 3573 | Sandman
      Hotels                                                                                                                                                 
      |

      | 391 | 3582 | California Hotel and
      Casino                                                                                                                                    
      |

      | 392 | 3574 | Venture
      Inn                                                                                                                                                    
      |

      | 393 | 3577 | Mandarin Oriental
      Hotel                                                                                                                                        
      |

      | 394 | 3581 | Delta
      Hotels                                                                                                                                                   
      |

      | 395 | 3579 | Hotel
      Mercure                                                                                                                                                  
      |

      | 396 | 3044 | Air
      Lanka                                                                                                                                                      
      |

      | 397 | 3042 |
      FinnAir                                                                                                                                                        
      |

      | 398 | 3049 | Tunis
      Air                                                                                                                                                      
      |

      | 399 | 3046 | Cruzeiro do Sul
      (Bra)                                                                                                                                          
      |

      | 400 | 3039 |
      Avianca                                                                                                                                                        
      |

      | 401 | 3037 |
      EgyptAir                                                                                                                                                       
      |

      | 402 | 3041 |
      Balkan-Bulgarian                                                                                                                                               
      |

      | 403 | 3043 | Aer
      Lingus                                                                                                                                                     
      |

      | 404 | 3051 | Austrian
      Airlines                                                                                                                                              
      |

      | 405 | 3035 | TAP
      (Portugal)                                                                                                                                                 
      |

      | 406 | 3033 | Ansett
      Airlines                                                                                                                                                
      |

      | 407 | 3045 | Nigeria
      Airways                                                                                                                                                
      |

      | 408 | 3048 | Royal Air
      Maroc                                                                                                                                                
      |

      | 409 | 3034 |
      ETIHADAIR                                                                                                                                                      
      |

      | 410 | 3040 | GulfAir
      (Bahrain)                                                                                                                                              
      |

      | 411 | 3050 |
      Icelandair                                                                                                                                                     
      |

      | 412 | 3038 | Kuwait
      Airways                                                                                                                                                 
      |

      | 413 | 3047 | THY
      (Turkey)                                                                                                                                                   
      |

      | 414 | 3036 | VASP
      (Brazil)                                                                                                                                                  
      |

      | 415 | 7210 | Laundry, Cleaning, and Garment
      Services                                                                                                                        
      |

      | 416 | 7261 | Funeral Services and
      Crematories                                                                                                                               
      |

      | 417 | 7251 | Shoe Repair Shops, Shoe Shine Parlors, and Hat Cleaning
      Shops                                                                                                  
      |

      | 418 | 6535 | Value Purchase - Member Financial
      Institution                                                                                                                  
      |

      | 419 | 7012 |
      Timeshares                                                                                                                                                     
      |

      | 420 | 6533 | Payment Transaction -
      Merchant                                                                                                                                 
      |

      | 421 | 6537 | MoneySend
      Intercountry                                                                                                                                         
      |

      | 422 | 6540 | POI Funding Transactions (Excluding
      MoneySend)                                                                                                                 
      |

      | 423 | 7032 | Sporting and Recreational
      Camps                                                                                                                                
      |

      | 424 | 7211 | Laundry Services - Family and
      Commercial                                                                                                                       
      |

      | 425 | 6534 | Money Transfer - Member Financial
      Institution                                                                                                                  
      |

      | 426 | 7273 | Dating
      Services                                                                                                                                                
      |

      | 427 | 6531 | Payment Service
      Provider                                                                                                                                       
      |

      | 428 | 7011 | Lodging - Hotels, Motels, and
      Resorts                                                                                                                          
      |

      | 429 | 7217 | Carpet and Upholstery
      Cleaning                                                                                                                                 
      |

      | 430 | 7033 | Trailer Parks and
      Campgrounds                                                                                                                                  
      |

      | 431 | 7216 | Dry
      Cleaners                                                                                                                                                   
      |

      | 432 | 7221 | Photographic
      Studios                                                                                                                                           
      |

      | 433 | 6538 | MoneySend
      Funding                                                                                                                                              
      |

      | 434 | 6536 | MoneySend
      Intracountry                                                                                                                                         
      |

      | 435 | 6532 | Payment Transaction -
      Member                                                                                                                                   
      |

      | 436 | 3353 | Brooks Rent a
      Car                                                                                                                                              
      |

      | 437 | 3368 | Holiday
      R-A-C                                                                                                                                                  
      |

      | 438 | 3380 | Triangle Rent a
      Car                                                                                                                                            
      |

      | 439 | 3364 | Agency Rent a
      Car                                                                                                                                              
      |

      | 440 | 3376 | Ajax
      R-A-C                                                                                                                                                     
      |

      | 441 | 3361 | Airways Rent a
      Car                                                                                                                                             
      |

      | 442 | 3354 | Action Auto
      Rental                                                                                                                                             
      |

      | 443 | 3352 | American
      International                                                                                                                                         
      |

      | 444 | 3355 | SIXT Car
      Rental                                                                                                                                                
      |

      | 445 | 3359 | Payless Car
      Rental                                                                                                                                             
      |

      | 446 | 3362 | Altra Auto
      Rental                                                                                                                                              
      |

      | 447 | 3374 | Accent
      Rent-A-Car                                                                                                                                              
      |

      | 448 | 3370 |
      Rent-a-Wreck                                                                                                                                                   
      |

      | 449 | 3366 | Budget Rent a
      Car                                                                                                                                              
      |

      | 450 | 3360 | Snappy Car
      Rental                                                                                                                                              
      |

      | 451 | 3357 |
      Hertz                                                                                                                                                          
      |

      | 452 | 3351 | Affiliated Auto
      Rental                                                                                                                                         
      |

      | 453 | 3758 | Kahala Mandarion Oriental
      Hotel                                                                                                                                
      |

      | 454 | 3751 | Homewood
      Suites                                                                                                                                                
      |

      | 455 | 3760 | Halekulani Hotel/Waikiki
      Parc                                                                                                                                  
      |

      | 456 | 3738 | Tropicana Resort &
      Casino                                                                                                                                      
      |

      | 457 | 3753 | Greenbriar
      Resorts                                                                                                                                             
      |

      | 458 | 3741 | Millennium
      Hotel                                                                                                                                               
      |

      | 459 | 3737 | Riviera Hotel and
      Casino                                                                                                                                       
      |

      | 460 | 3748 | Wellesley
      Inns                                                                                                                                                 
      |

      | 461 | 3740 | Towneplace
      Suites                                                                                                                                              
      |

      | 462 | 3749 | The Beverly Hills
      Hotel                                                                                                                                        
      |

      | 463 | 3762 | Whisky Pete's Hotel and
      Casino                                                                                                                                 
      |

      | 464 | 3746 | The Eliot
      Hotel                                                                                                                                                
      |

      | 465 | 3761 | Primadonna Hotel and
      Casino                                                                                                                                    
      |

      | 466 | 3759 | The Orchid at Mauna
      Lani                                                                                                                                       
      |

      | 467 | 3739 | Woodside Hotels &
      Resorts                                                                                                                                      
      |

      | 468 | 3750 | Crown Plaza
      Hotels                                                                                                                                             
      |

      | 469 | 3752 | Peabody
      Hotels                                                                                                                                                 
      |

      | 470 | 3764 | Beau Rivage Hotel and
      Casino                                                                                                                                   
      |

      | 471 | 3755 | The
      Homestead                                                                                                                                                  
      |

      | 472 | 3747 |
      ClubCorp/ClubResorts                                                                                                                                           
      |

      | 473 | 3754 | Amelia Island
      Plantation                                                                                                                                       
      |

      | 474 | 3736 | Colorado Belle/Edgewater
      Resort                                                                                                                                
      |

      | 475 | 3763 | Chateau Elan Winery and
      Resort                                                                                                                                 
      |

      | 476 | 3745 | St. Regis
      Hotel                                                                                                                                                
      |

      | 477 | 3757 | Canyon
      Ranch                                                                                                                                                   
      |

      | 478 | 3744 | Carefree
      Resorts                                                                                                                                               
      |

      | 479 | 3560 | Aladdin Resort and
      Casino                                                                                                                                      
      |

      | 480 | 3568 | Ladbroke
      Hotels                                                                                                                                                
      |

      | 481 | 3567 | Soho Grand
      Hotel                                                                                                                                               
      |

      | 482 | 3572 | Miyako
      Hotel                                                                                                                                                   
      |

      | 483 | 3562 | Comfort
      Inns                                                                                                                                                   
      |

      | 484 | 3564 | Sam's Town Hotel and
      Casino                                                                                                                                    
      |

      | 485 | 3561 | Golden
      Nugget                                                                                                                                                  
      |

      | 486 | 3570 | Forum
      Hotels                                                                                                                                                   
      |

      | 487 | 3566 | Garden Place
      Hotel                                                                                                                                             
      |

      | 488 | 3571 | Grand Wailea
      Resort                                                                                                                                            
      |

      | 489 | 3563 | Journey's End
      Motels                                                                                                                                           
      |

      | 490 | 3565 | Relax
      Inns                                                                                                                                                     
      |

      | 491 | 3569 | Tribeca Grand
      Hotel                                                                                                                                            
      |

      | 492 | 3031 | Olympic
      Airways                                                                                                                                                
      |

      | 493 | 3018 | Varig
      (Brazil)                                                                                                                                                 
      |

      | 494 | 3029 | SN Brussels Airlines - SN
      BRUSSELS                                                                                                                             
      |

      | 495 | 3025 | Air New Zealand
      Ltd.                                                                                                                                           
      |

      | 496 | 3015 |
      SWISS                                                                                                                                                          
      |

      | 497 | 3016 |
      SAS                                                                                                                                                            
      |

      | 498 | 3021 | Air
      Algerie                                                                                                                                                    
      |

      | 499 | 3022 | PAL
      AIR                                                                                                                                                        
      |

      | 500 | 3028 | Air
      Malta                                                                                                                                                      
      |

      | 501 | 3024 | Pakistan
      International                                                                                                                                         
      |

      | 502 | 3032 | El
      Al                                                                                                                                                          
      |

      | 503 | 3026 | Emirates
      Airlines                                                                                                                                              
      |

      | 504 | 3017 | South African
      Airway                                                                                                                                           
      |

      | 505 | 3030 | Aerolineas
      Argentinas                                                                                                                                          
      |

      | 506 | 3027 |
      UTA/InterAir                                                                                                                                                   
      |

      | 507 | 3020 | Air
      India                                                                                                                                                      
      |

      | 508 | 3023 |
      Mexicana                                                                                                                                                       
      |

      | 509 | 6300 | Insurance Sales and
      Underwriting                                                                                                                               
      |

      | 510 | 5992 |
      Florists                                                                                                                                                       
      |

      | 511 | 6051 | Visa - Non-Financial Institutions - Foreign Currency, Money
      Orders(not wire Transfer), & Travelers
      Cheques                                                      |

      | 512 | 5993 | Cigar Stores &
      Stands                                                                                                                                          
      |

      | 513 | 5983 | Fuel Dealers--Fuel Oil, Wood, Coal, and Liquefied
      Petroleum                                                                                                    
      |

      | 514 | 6381 | Insurance -
      Premiums                                                                                                                                           
      |

      | 515 | 5977 | Cosmetic
      Stores                                                                                                                                                
      |

      | 516 | 6530 | Remote Stored Value Load -
      Merchant                                                                                                                            
      |

      | 517 | 5998 | Tent and Awning
      Stores                                                                                                                                         
      |

      | 518 | 5999 | Miscellaneous & Specialty Retail
      Stores                                                                                                                        
      |

      | 519 | 6529 | Remote Stored Value Load - Member Financial
      Institution                                                                                                        
      |

      | 520 | 6010 | Financial Institutions--Manual Cash
      Disbursements                                                                                                              
      |

      | 521 | 6513 | Real Estate Agents and Managers - Rentals; Property
      Management                                                                                                 
      |

      | 522 | 5978 | Typewriter Stores--Sales, Service, and
      Rentals                                                                                                                 
      |

      | 523 | 6211 | Securities - Brokers and
      Dealers                                                                                                                               
      |

      | 524 | 6050 | Quasi Cash - Member Financial
      Institution                                                                                                                      
      |

      | 525 | 5996 | Swimming Pools--Sales, Supplies, and
      Services                                                                                                                  
      |

      | 526 | 6012 | Quasi Cash - Financial Institution - Merchandise and
      Services                                                                                                  
      |

      | 527 | 6011 | Financial Institutions--Automated Cash
      Disbursements                                                                                                           
      |

      | 528 | 5994 | News Dealers &
      Newsstands                                                                                                                                      
      |

      | 529 | 5995 | Pet Shops, Pet Food, and
      Supplies                                                                                                                              
      |

      | 530 | 5997 | Electric Razor Stores Sales &
      Services                                                                                                                         
      |

      | 531 | 3277 | Air
      Madagascar                                                                                                                                                 
      |

      | 532 | 3298 | Air
      Mauritius                                                                                                                                                  
      |

      | 533 | 3286 | Aero
      Nicaraguensis                                                                                                                                             
      |

      | 534 | 3296 | Air
      Berlin-AIRBERLIN                                                                                                                                           
      |

      | 535 | 3287 | Aero Coach
      Aviation                                                                                                                                            
      |

      | 536 | 3282 | Air
      Djibouti                                                                                                                                                   
      |

      | 537 | 3279 | Air
      LA                                                                                                                                                         
      |

      | 538 | 3276 | Air
      Midwest                                                                                                                                                    
      |

      | 539 | 3295 | Kenya
      Airways                                                                                                                                                  
      |

      | 540 | 3293 |
      Ecuatoriana                                                                                                                                                    
      |

      | 541 | 3292 | Cyprus
      Airways                                                                                                                                                 
      |

      | 542 | 3285 |
      AeroPeru                                                                                                                                                       
      |

      | 543 | 3275 | Air
      Nevada                                                                                                                                                     
      |

      | 544 | 3294 | Ethiopian
      Airlines                                                                                                                                             
      |

      | 545 | 3280 | Air
      Jamaica                                                                                                                                                    
      |

      | 546 | 3291 | Ariana
      Afghan                                                                                                                                                  
      |

      | 547 | 3299 | Wideroe's
      Flyveselskap                                                                                                                                         
      |

      | 548 | 3297 | Tarom Romanian Air
      Transport                                                                                                                                   
      |

      | 549 | 3729 | John Ascuaga's
      Nugget                                                                                                                                          
      |

      | 550 | 3734 | Harvey/Bristol
      Hotels                                                                                                                                          
      |

      | 551 | 3730 | MGM Grand
      Hotel                                                                                                                                                
      |

      | 552 | 3723 | Rica
      Hotels                                                                                                                                                    
      |

      | 553 | 3728 | Bally's Hotel and
      Casino                                                                                                                                       
      |

      | 554 | 3725 | SeaPines
      Plantation                                                                                                                                            
      |

      | 555 | 3735 | Master Economy
      Inns                                                                                                                                            
      |

      | 556 | 3732 | Opryland
      Hotel                                                                                                                                                 
      |

      | 557 | 3731 | Harrah's Hotels and
      Casinos                                                                                                                                    
      |

      | 558 | 3721 | Hilton Conrad
      Hotels                                                                                                                                           
      |

      | 559 | 3722 | Wyndham
      Hotels                                                                                                                                                 
      |

      | 560 | 3726 | Rio
      Suites                                                                                                                                                     
      |

      | 561 | 3724 | Inter Nor
      Hotels                                                                                                                                               
      |

      | 562 | 3727 | Broadmoor
      Hotel                                                                                                                                                
      |

      | 563 | 3556 | Barton Creek
      Resort                                                                                                                                            
      |

      | 564 | 3555 | Treasure Island Hotel and
      Casino                                                                                                                               
      |

      | 565 | 3552 | Coast
      Hotel                                                                                                                                                    
      |

      | 566 | 3553 | Park Inn by
      Radisson                                                                                                                                           
      |

      | 567 | 3546 | Hotel
      Sierra                                                                                                                                                   
      |

      | 568 | 3551 | Mirage Hotel and
      Casino                                                                                                                                        
      |

      | 569 | 3542 | Royal
      Hotels                                                                                                                                                   
      |

      | 570 | 3545 | Shangri-La
      International                                                                                                                                       
      |

      | 571 | 3549 | Auberge des
      Governeurs                                                                                                                                         
      |

      | 572 | 3558 | Jolly
      Hotels                                                                                                                                                   
      |

      | 573 | 3543 | Four
      Seasons                                                                                                                                                   
      |

      | 574 | 3559 | Candlewood
      Suites                                                                                                                                              
      |

      | 575 | 3544 | Cigna
      Hotels                                                                                                                                                   
      |

      | 576 | 3554 | Pinehurst
      Resort                                                                                                                                               
      |

      | 577 | 3557 | Manhattan East Suite
      Hotels                                                                                                                                    
      |

      | 578 | 3548 | Hotels
      Melia                                                                                                                                                   
      |

      | 579 | 3550 | Regal 8
      Inns                                                                                                                                                   
      |

      | 580 | 3000 | United
      Airlines                                                                                                                                                
      |

      | 581 | 3012 |
      Qantas                                                                                                                                                         
      |

      | 582 | 3008 |
      Lufthansa                                                                                                                                                      
      |

      | 583 | 3006 | Japan Air
      Lines                                                                                                                                                
      |

      | 584 | 3007 | Air
      France                                                                                                                                                     
      |

      | 585 | 3002 | Pan
      American                                                                                                                                                   
      |

      | 586 | 3001 | American
      Airlines                                                                                                                                              
      |

      | 587 | 3009 | Air
      Canada                                                                                                                                                     
      |

      | 588 | 3004 | Dragon
      Airlines                                                                                                                                                
      |

      | 589 | 3011 |
      AeroFlot                                                                                                                                                       
      |

      | 590 | 3010 |
      KLM                                                                                                                                                            
      |

      | 591 | 3014 | Saudi Arabian
      Airlines                                                                                                                                         
      |

      | 592 | 2842 | Specialty Cleaning, Polishing and Sanitation Preparations
      (Business to Business
      MCC)                                                                           
      |

      | 593 | 3013 |
      Alitalia                                                                                                                                                       
      |

      | 594 | 3005 | British
      Airways                                                                                                                                                
      |

      | 595 | 3003 | Eurofly
      Airlines                                                                                                                                               
      |

      | 596 | 5946 | Camera and Photographic Supply
      Stores                                                                                                                          
      |

      | 597 | 5963 | Direct Selling Establishments/Door to Door
      Sales                                                                                                               
      |

      | 598 | 5965 | Combined Catalog and Retail
      Merchant                                                                                                                           
      |

      | 599 | 5975 | Hearing Aids--Sales, Service, and
      Supplies                                                                                                                     
      |

      | 600 | 5932 | Antique
      Shop                                                                                                                                                   
      |

      | 601 | 5949 | Sewing, Needlework, Fabric, and Piece Good
      Stores                                                                                                              
      |

      | 602 | 5968 | Continuity/Subscription
      Merchants                                                                                                                              
      |

      | 603 | 5961 | Mail
      Order                                                                                                                                                     
      |

      | 604 | 5942 | Book
      Stores                                                                                                                                                    
      |

      | 605 | 5967 | Direct Marketing -- Inbound Telemarketing
      Merchants                                                                                                            
      |

      | 606 | 5940 | Bicycle Shop-Sales and
      Services                                                                                                                                
      |

      | 607 | 5944 | Jewelry, Watch, Clock, and Silverware
      Stores                                                                                                                   
      |

      | 608 | 5973 | Religious Goods
      Stores                                                                                                                                         
      |

      | 609 | 5976 | Orthopedic Goods and Prosthetic
      Devices                                                                                                                        
      |

      | 610 | 5962 | Direct Marketing -- Travel Related Arrangement
      Services                                                                                                        
      |

      | 611 | 5972 | Stamp and Coin
      Stores                                                                                                                                          
      |

      | 612 | 5941 | Sporting Goods
      Stores                                                                                                                                          
      |

      | 613 | 5947 | Gift, Card, Novelty, and Souvenir
      Stores                                                                                                                       
      |

      | 614 | 5960 | Direct Marketing Insurance
      Services                                                                                                                            
      |

      | 615 | 5935 | Wrecking and Salvage
      Yards                                                                                                                                     
      |

      | 616 | 5937 | Antique Reproduction
      Stores                                                                                                                                    
      |

      | 617 | 5950 | Glassware and Crystal
      Stores                                                                                                                                   
      |

      | 618 | 5966 | Outbound Telemarketing
      Merchant                                                                                                                                
      |

      | 619 | 5969 | Direct Marketing/Direct Marketers--Not Elsewhere
      Classified                                                                                                    
      |

      | 620 | 5933 | Pawn
      Shop                                                                                                                                                      
      |

      | 621 | 5945 | Hobby, Toy and Game
      Stores                                                                                                                                     
      |

      | 622 | 5970 | Artist Supply and Craft
      Stores                                                                                                                                 
      |

      | 623 | 5943 | Stationery, Office and School Supply
      Stores                                                                                                                    
      |

      | 624 | 5948 | Luggage and Leather Goods
      Stores                                                                                                                               
      |

      | 625 | 5971 | Art Dealers and
      Galleries                                                                                                                                      
      |

      | 626 | 5964 | Catalog
      Merchant                                                                                                                                               
      |

      | 627 | 3247 | Gol Airlines -
      GOL                                                                                                                                             
      |

      | 628 | 3241 | Aviateca
      (Guatemala)                                                                                                                                           
      |

      | 629 | 3267 | Air Panama
      International                                                                                                                                       
      |

      | 630 | 3260 | Spirit Airlines -
      SPIRIT                                                                                                                                       
      |

      | 631 | 3245 | Easy Jet -
      EASYJET                                                                                                                                             
      |

      | 632 | 3243 | Austrian Air
      Service                                                                                                                                           
      |

      | 633 | 3246 | Ryan Air -
      RYANAIR                                                                                                                                             
      |

      | 634 | 3240 |
      Bahamasair                                                                                                                                                     
      |

      | 635 | 3268 | Air
      Pacific                                                                                                                                                    
      |

      | 636 | 3261 | Air
      China                                                                                                                                                      
      |

      | 637 | 3256 | Alaska Airlines
      Inc.                                                                                                                                           
      |

      | 638 | 3252 | ALM-Antilean
      Airlines                                                                                                                                          
      |

      | 639 | 3248 | Tam Airlines -
      TAM                                                                                                                                             
      |

      | 640 | 3263 | Aero Servicio
      Carabobo                                                                                                                                         
      |

      | 641 | 3266 | Air
      Seychelles                                                                                                                                                 
      |

      | 642 | 3242 |
      Avensa                                                                                                                                                         
      |

      | 643 | 3239 | Bar Harbor
      Airlines                                                                                                                                            
      |

      | 644 | 3709 | Super 8
      Motels                                                                                                                                                 
      |

      | 645 | 3707 | Shoney's
      Inn                                                                                                                                                   
      |

      | 646 | 3714 | Four Seasons
      Hotels-Austr                                                                                                                                      
      |

      | 647 | 3708 | Virgin River Hotel and
      Casino                                                                                                                                  
      |

      | 648 | 3717 | City Lodge
      Hotels                                                                                                                                              
      |

      | 649 | 3716 | Carlton
      Hotels                                                                                                                                                 
      |

      | 650 | 3706 | Shilo
      Inn                                                                                                                                                      
      |

      | 651 | 3712 | Buffalo Bill's Hotel and
      Casino                                                                                                                                
      |

      | 652 | 3720 | Southern Sun
      Hotels                                                                                                                                            
      |

      | 653 | 3704 | Royce
      Hotels                                                                                                                                                   
      |

      | 654 | 3713 | Quality Pacific
      Hotel                                                                                                                                          
      |

      | 655 | 3705 | Sandman
      Inn                                                                                                                                                    
      |

      | 656 | 3711 | Flag Inns
      (Australia)                                                                                                                                          
      |

      | 657 | 3719 | Protea
      Hotels                                                                                                                                                  
      |

      | 658 | 3710 | The Ritz Carlton
      Hotels                                                                                                                                        
      |

      | 659 | 3718 | Karos
      Hotels                                                                                                                                                   
      |

      | 660 | 3715 | Fairfield
      Inn                                                                                                                                                  
      |

      | 661 | 3530 | Renaissance
      Hotels                                                                                                                                             
      |

      | 662 | 3540 | Iberotel
      Hotels                                                                                                                                                
      |

      | 663 | 3527 | Downtowner
      Passport                                                                                                                                            
      |

      | 664 | 3534 | Southern
      Pacific                                                                                                                                               
      |

      | 665 | 3524 | WelcomGroup
      Hotels                                                                                                                                             
      |

      | 666 | 3537 | ANA
      Hotels                                                                                                                                                     
      |

      | 667 | 3533 | Hotel
      Ibis                                                                                                                                                     
      |

      | 668 | 3531 | Kauai Coconut Beach
      Resort                                                                                                                                     
      |

      | 669 | 3538 | Concorde
      Hotels                                                                                                                                                
      |

      | 670 | 3541 | Hotel
      Okura                                                                                                                                                    
      |

      | 671 | 3536 | AMFAC
      Hotels                                                                                                                                                   
      |

      | 672 | 3529 | CP (Canadian
      Pacific)                                                                                                                                          
      |

      | 673 | 3526 | Prince
      Hotels                                                                                                                                                  
      |

      | 674 | 3532 | Royal Kona
      Resort                                                                                                                                              
      |

      | 675 | 3535 | Hilton
      International                                                                                                                                           
      |

      | 676 | 3539 | Summerfield Suites
      Hotel                                                                                                                                       
      |

      | 677 | 3528 | Red Lion
      Inns                                                                                                                                                  
      |

      | 678 | 3525 | Dunfey
      Hotels                                                                                                                                                  
      |

      | 679 | 0763 | Agricultural
      Cooperatives                                                                                                                                      
      |

      | 680 | 1740 | Masonry, Stonework, Tile Setting, Plastering, Insulation
      Contractors                                                                                           
      |

      | 681 | 0780 | Landscaping and Horticultural
      Services                                                                                                                         
      |

      | 682 | 1750 |
      Carpentry                                                                                                                                                      
      |

      | 683 | 1711 | Heating, Plumbing, Air Conditioning
      Contractors                                                                                                                
      |

      | 684 | 2791 | Typesetting, Plate Making and Related Services (Business to
      Business
      MCC)                                                                                      
      |

      | 685 | 1731 | Electrical
      Contractors                                                                                                                                         
      |

      | 686 | 1761 | Roof, Siding, and Sheet Metal Work
      Contractors                                                                                                                 
      |

      | 687 | 2741 | Miscellaneous Publishing and Printing
      Services                                                                                                                 
      |

      | 688 | 1799 | Special Trade Contractor - Not Elsewhere
      Classified                                                                                                            
      |

      | 689 | 1771 | Contractors,
      Concrete                                                                                                                                          
      |

      | 690 | 0742 | Veterinary
      Services                                                                                                                                            
      |

      | 691 | 1520 | General Contractor/Residential
      Building                                                                                                                        
      |

      | 692 | 5722 | Household Appliance
      Stores                                                                                                                                     
      |

      | 693 | 5718 | Fireplaces, Fireplace Screens and Accessories
      Stores                                                                                                           
      |

      | 694 | 5719 | Miscellaneous Home Furnishing Specialty
      Stores                                                                                                                 
      |

      | 695 | 5921 | Package Stores--Beer, Wine, and
      Liquor                                                                                                                         
      |

      | 696 | 5817 | Digital Goods – Applications (Excludes
      Games)                                                                                                                  
      |

      | 697 | 5816 | Digital Goods –
      Games                                                                                                                                          
      |

      | 698 | 5812 | Eating Places and
      Restaurants                                                                                                                                  
      |

      | 699 | 5912 | Drug Stores and
      Pharmacies                                                                                                                                     
      |

      | 700 | 5732 | Electronics
      Stores                                                                                                                                             
      |

      | 701 | 5813 | Drinking Places (Alcoholic Beverages) - Bars, Taverns,
      Nightclubs, Cocktail Lounges, and
      Discotheques                                                           |

      | 702 | 5735 | Record
      Stores                                                                                                                                                  
      |

      | 703 | 5734 | Computer Software
      Stores                                                                                                                                       
      |

      | 704 | 5713 | Floor coverings,
      Rugs                                                                                                                                          
      |

      | 705 | 5814 | Quick Payment Service-Fast Food
      Restaurants                                                                                                                    
      |

      | 706 | 5733 | Music Stores-Musical Instruments, Pianos, and Sheet
      Music                                                                                                      
      |

      | 707 | 5931 | Used Merchandise and Secondhand
      Stores                                                                                                                         
      |

      | 708 | 5811 | Caterers - Prepare &
      Delivery                                                                                                                                  
      |

      | 709 | 5818 | Large Digital Goods
      Merchant                                                                                                                                   
      |

      | 710 | 5714 | Drapery, Window Covering, and Upholstery
      Stores                                                                                                                
      |

      | 711 | 5815 | Digital Goods – Media, Books, Movies,
      Music                                                                                                                    
      |

      | 712 | 3229 |
      SAETA                                                                                                                                                          
      |

      | 713 | 3217 | CSA-Ceskoslovenske
      Aeroln                                                                                                                                      
      |

      | 714 | 3231 |
      SAHSA                                                                                                                                                          
      |

      | 715 | 3228 | Cayman
      Airways                                                                                                                                                 
      |

      | 716 | 3226 | Skyways\_ Air-
      SKYWAYS                                                                                                                                         
      |

      | 717 | 3222 | Command
      Airways                                                                                                                                                
      |

      | 718 | 3220 | Compania
      Faucett                                                                                                                                               
      |

      | 719 | 3213 | Malmo Aviation - MALMO
      AV                                                                                                                                      
      |

      | 720 | 3211 | Norwegian Air Shuttle -
      NORWEGIANAIR                                                                                                                           
      |

      | 721 | 3219 |
      Copa                                                                                                                                                           
      |

      | 722 | 3212 | Dominicana de
      Aviacion                                                                                                                                         
      |

      | 723 | 3206 | China Eastern Airlines (Abbr: China East
      Air)                                                                                                                  
      |

      | 724 | 3223 |
      Comair                                                                                                                                                         
      |

      | 725 | 3236 | Air Arabia Airlines - Air
      Arab                                                                                                                                 
      |

      | 726 | 3204 | Freedom
      Airlines                                                                                                                                               
      |

      | 727 | 3200 | Guyana
      Airways                                                                                                                                                 
      |

      | 728 | 3221 | Transportes Aeros
      Mil                                                                                                                                          
      |

      | 729 | 3234 |
      CARIBAIR                                                                                                                                                       
      |

      | 730 | 3207 | Empresa
      Ecuatoriana                                                                                                                                            
      |

      | 731 | 3691 | Dillon
      Inn                                                                                                                                                     
      |

      | 732 | 3700 | Motel
      6                                                                                                                                                        
      |

      | 733 | 3703 | Residence
      Inn                                                                                                                                                  
      |

      | 734 | 3689 | Consort
      Hotels                                                                                                                                                 
      |

      | 735 | 3694 | Economy Inns of
      America                                                                                                                                        
      |

      | 736 | 3693 | Drury
      Inn                                                                                                                                                      
      |

      | 737 | 3699 | Midway Motor
      Lodge                                                                                                                                             
      |

      | 738 | 3698 | Harley
      Hotels                                                                                                                                                  
      |

      | 739 | 3702 | The Registry
      Hotels                                                                                                                                            
      |

      | 740 | 3697 | Fairfield
      Hotels                                                                                                                                               
      |

      | 741 | 3701 | La Mansion Del
      Rio                                                                                                                                             
      |

      | 742 | 3695 | Embassy
      Suites                                                                                                                                                 
      |

      | 743 | 3690 | Courtyard
      Inns                                                                                                                                                 
      |

      | 744 | 3692 |
      Doubletree                                                                                                                                                     
      |

      | 745 | 3696 | Excel
      Inn                                                                                                                                                      
      |

      | 746 | 6399 | Insurance - Not Elsewhere
      Classified                                                                                                                           
      |

      | 747 | 9222 |
      Fines                                                                                                                                                          
      |

      | 748 | 9753 | Consumer Electronics/Furniture
      Store                                                                                                                           
      |

      | 749 | 9752 | U.K. Petrol Stations, Electronic Hot
      File                                                                                                                      
      |

      | 750 | 9311 | Tax
      Payments                                                                                                                                                   
      |

      | 751 | 9399 | Government Services - Not Elsewhere
      Classified                                                                                                                 
      |

      | 752 | 9751 | U.K. Supermarkets, Electronic Hot
      File                                                                                                                         
      |

      | 753 | 5262 |
      Marketplaces                                                                                                                                                   
      |

      | 754 | 8931 | Accounting, Auditing, and Bookkeeping
      Services                                                                                                                 
      |

      | 755 | 8999 | Professional Services - Not Elsewhere
      Classified                                                                                                               
      |

      | 756 | 2047 | Dog and Cat Food
      Mfg                                                                                                                                           
      |

      | 757 | 9754 | Quasi Cash - Gambling-Horse Racing, Dog Racing, State
      Lotteries                                                                                                
      |

      | 758 | 9701 | Visa Credential
      Server                                                                                                                                         
      |

      | 759 | 9401 |
      i-Purchasing                                                                                                                                                   
      |

      | 760 | 9950 | Intra-Company
      Purchases                                                                                                                                        
      |

      | 761 | 9700 | Automated Referral
      Service                                                                                                                                     
      |

      | 762 | 9223 | Bail & Bond
      Payments                                                                                                                                           
      |

      | 763 | 9211 | Court Costs, including Alimony and Child
      Support                                                                                                               
      |

      | 764 | 9702 | GCAS Emergency
      Services                                                                                                                                        
      |

      | 765 | 9402 | Postal
      Services                                                                                                                                                
      |

      | 766 | 9405 | U.S. Fed Government
      Agencies                                                                                                                                   
      |

      | 767 | 3516 | LaQuinta Motor
      Inns                                                                                                                                            
      |

      | 768 | 3511 | Arabella
      Hotels                                                                                                                                                
      |

      | 769 | 3519 | Pullman International
      Hotels                                                                                                                                   
      |

      | 770 | 3518 | Sol
      Hotels                                                                                                                                                     
      |

      | 771 | 3510 | Days Inn Colonial
      Resort                                                                                                                                       
      |

      | 772 | 3522 | Tokyo
      Group                                                                                                                                                    
      |

      | 773 | 3508 | Quality
      Inns                                                                                                                                                   
      |

      | 774 | 3509 |
      Marriott                                                                                                                                                       
      |

      | 775 | 3520 | Meridien
      Hotels                                                                                                                                                
      |

      | 776 | 3523 | Peninsula
      Hotels                                                                                                                                               
      |

      | 777 | 3512 | Intercontinental
      Hotels                                                                                                                                        
      |

      | 778 | 3521 | Royal Lahaina
      Resort                                                                                                                                           
      |

      | 779 | 3506 | Golden Tulip
      Hotels                                                                                                                                            
      |

      | 780 | 3517 | Americana
      Hotels                                                                                                                                               
      |

      | 781 | 3514 |
      Amerisuites                                                                                                                                                    
      |

      | 782 | 3513 |
      Westin                                                                                                                                                         
      |

      | 783 | 3515 | Rodeway
      Inn                                                                                                                                                    
      |

      | 784 | 3507 | Friendship
      Inns                                                                                                                                                
      |

      | 785 | 5592 | Motor Home
      Dealers                                                                                                                                             
      |

      | 786 | 5681 | Furriers & Fur
      Shops                                                                                                                                           
      |

      | 787 | 5598 | Snowmobile
      Dealers                                                                                                                                             
      |

      | 788 | 5611 | Men's & Boys' Clothing and Accessory
      Stores                                                                                                                    
      |

      | 789 | 5651 | Family Clothing
      Stores                                                                                                                                         
      |

      | 790 | 5699 | Miscellaneous Apparel and Accessory
      Stores                                                                                                                     
      |

      | 791 | 5697 | Tailors, Seamstresses, Mending,
      Alterations                                                                                                                    
      |

      | 792 | 5599 | Miscellaneous Automotive, Aircraft, and Farm Equipment
      Dealers --Not Elsewhere
      Classified                                                                      
      |

      | 793 | 5712 | Furniture, Home Furnishings, and Equipment Stores, except
      Appliances                                                                                           
      |

      | 794 | 5641 | Children's and Infants' Wear
      Stores                                                                                                                            
      |

      | 795 | 5655 | Sports and Riding Apparel
      Stores                                                                                                                               
      |

      | 796 | 5631 | Women's Accessory and Specialty
      Stores                                                                                                                         
      |

      | 797 | 5698 | Wig & Toupee
      Shops                                                                                                                                             
      |

      | 798 | 5661 | Shoe
      Stores                                                                                                                                                    
      |

      | 799 | 5621 | Women's Ready-to-Wear
      Stores                                                                                                                                   
      |

      | 800 | 5691 | Men's and Women's Clothing
      Stores                                                                                                                              
      |

      | 801 | 3198 | Harbor
      Airlines                                                                                                                                                
      |

      | 802 | 3180 | Westjet
      Airlines-WESTJET                                                                                                                                       
      |

      | 803 | 3178 | Mesa
      Air                                                                                                                                                       
      |

      | 804 | 3196 | Hawaiian
      Air                                                                                                                                                   
      |

      | 805 | 3185 | LAV
      (Venezuela)                                                                                                                                                
      |

      | 806 | 3177 | AirTran
      Airways                                                                                                                                                
      |

      | 807 | 3190 | Jugoslav
      Air                                                                                                                                                   
      |

      | 808 | 3181 | Malev Hungarian
      Airlines                                                                                                                                       
      |

      | 809 | 3183 | Oman Aviation - OMAN
      AIR                                                                                                                                       
      |

      | 810 | 3186 | LAP
      (Paraguay)                                                                                                                                                 
      |

      | 811 | 3187 | LACSA (Costa
      Rica)                                                                                                                                             
      |

      | 812 | 3191 | Island
      Airlines                                                                                                                                                
      |

      | 813 | 3193 | Indian
      Airlines                                                                                                                                                
      |

      | 814 | 3188 | Virgin Express - VIR
      EXP                                                                                                                                       
      |

      | 815 | 3199 | Servicios Aereos
      Militares                                                                                                                                     
      |

      | 816 | 3195 | Holiday
      Airlines                                                                                                                                               
      |

      | 817 | 3182 | LOT
      (Poland)                                                                                                                                                   
      |

      | 818 | 3184 |
      LIAT                                                                                                                                                           
      |

      | 819 | 3197 | Havasu
      Airlines                                                                                                                                                
      |

      | 820 | 3685 | Budgetel
      Hotels                                                                                                                                                
      |

      | 821 | 3682 | Sahara Hotel and
      Casino                                                                                                                                        
      |

      | 822 | 3671 | Arctia
      Hotels                                                                                                                                                  
      |

      | 823 | 3676 | Monte Carlo Hotel and
      Casino                                                                                                                                   
      |

      | 824 | 3675 | Interhotel
      CEDOK                                                                                                                                               
      |

      | 825 | 3678 | Cumulus
      Hotels                                                                                                                                                 
      |

      | 826 | 3673 | IBUSZ
      Hotels                                                                                                                                                   
      |

      | 827 | 3680 | Hoteis
      Othan                                                                                                                                                   
      |

      | 828 | 3688 | Compri
      Hotels                                                                                                                                                  
      |

      | 829 | 3681 | Adams Mark
      Hotels                                                                                                                                              
      |

      | 830 | 3674 | Rantasipi
      Hotels                                                                                                                                               
      |

      | 831 | 3684 | Budget Hosts
      Inns                                                                                                                                              
      |

      | 832 | 3679 | Silver Legacy Hotel and
      Casino                                                                                                                                 
      |

      | 833 | 3683 | Bradbury
      Suites                                                                                                                                                
      |

      | 834 | 3686 | Suisse
      Chalet                                                                                                                                                  
      |

      | 835 | 3677 | Climat de France
      Hotels                                                                                                                                        
      |

      | 836 | 3672 | Campanile
      Hotels                                                                                                                                               
      |

      | 837 | 3687 | Clarion
      Hotels                                                                                                                                                 
      |

      | 838 | 8299 | Schools and Educational Services - Not Elsewhere
      Classified                                                                                                    
      |

      | 839 | 8641 | Civic, Social, and Fraternal
      Associations                                                                                                                      
      |

      | 840 | 8398 | Charitable and Social Service
      Organizations                                                                                                                    
      |

      | 841 | 8699 | Membership Organizations - Not Elsewhere
      Classified                                                                                                            
      |

      | 842 | 8675 | Automobile
      Associations                                                                                                                                        
      |

      | 843 | 8651 | Political
      Organizations                                                                                                                                        
      |

      | 844 | 8734 | Testing Laboratories (Not Medical) - (Business to Business
      MCC)                                                                                                
      |

      | 845 | 8661 | Religious
      Organizations                                                                                                                                        
      |

      | 846 | 8249 | Trade and Vocational
      Schools                                                                                                                                   
      |

      | 847 | 8244 | Business and Secretarial
      Schools                                                                                                                               
      |

      | 848 | 8351 | Child Care
      Services                                                                                                                                            
      |

      | 849 | 8911 | Architectural, Engineering, and Surveying
      Services                                                                                                             
      |

      | 850 | 3439 | Millville
      Rent-a-Car                                                                                                                                           
      |

      | 851 | 3441 | Advantage Rent A
      Car                                                                                                                                           
      |

      | 852 | 3505 | Forte
      Hotels                                                                                                                                                   
      |

      | 853 | 3433 | Ugly Duckling
      R-A-C                                                                                                                                            
      |

      | 854 | 3435 | Value
      Rent-a-Car                                                                                                                                               
      |

      | 855 | 3504 |
      Hilton                                                                                                                                                         
      |

      | 856 | 3502 | Best Western
      Hotels                                                                                                                                            
      |

      | 857 | 3501 | Holiday
      Inns                                                                                                                                                   
      |

      | 858 | 3503 |
      Sheraton                                                                                                                                                       
      |

      | 859 | 3438 | Interenet
      Rent-a-Car                                                                                                                                           
      |

      | 860 | 3434 | USA
      Rent-a-Car                                                                                                                                                 
      |

      | 861 | 3436 | Autohansa
      Rent-a-Car                                                                                                                                           
      |

      | 862 | 5310 | Discount
      Store                                                                                                                                                 
      |

      | 863 | 5551 | Boat
      Dealers                                                                                                                                                   
      |

      | 864 | 5531 | Auto and Home Supply
      Stores                                                                                                                                    
      |

      | 865 | 5541 | Service Stations (with or without Ancillary
      Services)                                                                                                          
      |

      | 866 | 5311 | Department
      Stores                                                                                                                                              
      |

      | 867 | 5331 | Variety
      Stores                                                                                                                                                 
      |

      | 868 | 5533 | Automotive Parts and Accessories
      Stores                                                                                                                        
      |

      | 869 | 5411 | Grocery Stores and
      Supermarkets                                                                                                                                
      |

      | 870 | 5571 | Motorcycle
      Dealers                                                                                                                                             
      |

      | 871 | 5441 | Candy, Nut, and Confectionary
      Stores                                                                                                                           
      |

      | 872 | 5462 |
      Bakeries                                                                                                                                                       
      |

      | 873 | 5309 | Duty Free
      Stores                                                                                                                                               
      |

      | 874 | 5511 | Car and Truck Dealers (New and Used)- Sales, Service,
      Repairs, Parts, and
      Leasing                                                                              
      |

      | 875 | 5300 | Wholesale Club with or without membership
      fee                                                                                                                  
      |

      | 876 | 5521 | Car and Truck Dealers (Used)- Sales, Service, Repairs,
      Parts, and
      Leasing                                                                                      
      |

      | 877 | 5399 | Miscellaneous General
      Merchandise                                                                                                                              
      |

      | 878 | 5422 | Freezer & Locker Meat
      Provisions                                                                                                                               
      |

      | 879 | 5532 | Automotive Tire
      Stores                                                                                                                                         
      |

      | 880 | 5542 | Automated Fuel
      Dispensers                                                                                                                                      
      |

      | 881 | 5451 | Dairy Product
      Stores                                                                                                                                           
      |

      | 882 | 5499 | Miscellaneous Food Stores-Convenience Stores and Specialty
      Markets                                                                                             
      |

      | 883 | 7322 | Collection
      Agency                                                                                                                                              
      |

      </details>



      <details>

      <summary>Partner Statuses</summary>


      | id | name      |

      |----|-----------|

      | 1  | Active    |

      | 2  | Suspended |

      </details>


      <details>

      <summary>Partner Business Model Types</summary>


      | id | name                 |

      |----|----------------------|

      | 1  | SingleAffiliateModel |

      | 2  | SubAffiliateModel    |

      </details>


      <details>

      <summary>Payment Method Types</summary>


      | id | name            |

      |----|-----------------|

      | 1  | Card            |

      | 2  | ElectronicCheck |

      </details>


      <details>

      <summary>Payment Processor Statuses</summary>


      | id | name     |

      |----|----------|

      | 1  | Active   |

      | 2  | Inactive |

      </details>


      <details>

      <summary>Payment Processor Types</summary>


      | id | name |

      |----|------|

      | 1  | TSYS |

      | 2  | EFT  |

      </details>


      <details>

      <summary>States</summary>

      <a id="flute-states-codes"></a>


      | id | countryId | code | name           |

      |:--:|:---------:|:----:|----------------|

      | 1  | 1         | AL   | Alabama        |

      | 2  | 1         | AK   | Alaska         |

      | 3  | 1         | AR   | Arkansas       |

      | 4  | 1         | AZ   | Arizona        |

      | 5  | 1         | CA   | California     |

      | 6  | 1         | CO   | Colorado       |

      | 7  | 1         | CT   | Connecticut    |

      | 8  | 1         | DC   | D.C.           |

      | 9  | 1         | DE   | Delaware       |

      | 10 | 1         | FL   | Florida        |

      | 11 | 1         | GA   | Georgia        |

      | 12 | 1         | HI   | Hawaii         |

      | 13 | 1         | IA   | Iowa           |

      | 14 | 1         | ID   | Idaho          |

      | 15 | 1         | IL   | Illinois       |

      | 16 | 1         | IN   | Indiana        |

      | 17 | 1         | KS   | Kansas         |

      | 18 | 1         | KY   | Kentucky       |

      | 19 | 1         | LA   | Louisiana      |

      | 20 | 1         | MA   | Massachusetts  |

      | 21 | 1         | MD   | Maryland       |

      | 22 | 1         | ME   | Maine          |

      | 23 | 1         | MI   | Michigan       |

      | 24 | 1         | MN   | Minnesota      |

      | 25 | 1         | MO   | Missouri       |

      | 26 | 1         | MS   | Mississippi    |

      | 27 | 1         | MT   | Montana        |

      | 28 | 1         | NC   | North Carolina |

      | 29 | 1         | ND   | North Dakota   |

      | 30 | 1         | NE   | Nebraska       |

      | 31 | 1         | NH   | New Hampshire  |

      | 32 | 1         | NJ   | New Jersey     |

      | 33 | 1         | NM   | New Mexico     |

      | 34 | 1         | NV   | Nevada         |

      | 35 | 1         | NY   | New York       |

      | 36 | 1         | OK   | Oklahoma       |

      | 37 | 1         | OH   | Ohio           |

      | 38 | 1         | OR   | Oregon         |

      | 39 | 1         | PA   | Pennsylvania   |

      | 40 | 1         | RI   | Rhode Island   |

      | 41 | 1         | SC   | South Carolina |

      | 42 | 1         | SD   | South Dakota   |

      | 43 | 1         | TN   | Tennessee      |

      | 44 | 1         | TX   | Texas          |

      | 45 | 1         | UT   | Utah           |

      | 46 | 1         | VA   | Virginia       |

      | 47 | 1         | VT   | Vermont        |

      | 48 | 1         | WA   | Washington     |

      | 49 | 1         | WI   | Wisconsin      |

      | 50 | 1         | WV   | West Virginia  |

      | 51 | 1         | WY   | Wyoming        |

      </details>


      <details>

      <summary>Payment Session Statuses</summary>


      | id   | name      |

      |------|-----------|

      | 1    | Created   |

      | 2    | Cancelled |

      | 3    | Completed |

      | 4    | Failed    |

      </details>


      <details>

      <summary>Transaction Statuses</summary>

      <a id="flute-transaction-statuses"></a>


      | Status Code | Status               |
      Description                                                                                                                                                                                                                                                                                   
      | Available actions |

      |-------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|

      | 1           | Authorized           | Transaction status after an
      approved `pre-authorization`
      request                                                                                                                                                                                                                              
      | Capture, Void     |

      | 2           | Captured             | Transaction status after aproved
      `sale` or `capture`
      request                                                                                                                                                                                                                                  
      | Void              |

      | 3           | Voided               | Transaction status after merchant
      voids an `authorized` request or refunds a `captured` (not settled)
      request                                                                                                                                                                                 
      | N/A               |

      | 4           | Refunded             | Transaction status after merchant
      refunds a `settled`
      request                                                                                                                                                                                                                                 
      | N/A               |

      | 5           | Verified             |
      NA                                                                                                                                                                                                                                                                                            
      | N/A               |

      | 6           | Settled              | Transaction status after successful
      settlement request. All `captured` transactions should have status changed
      to
      `settled`                                                                                                                                                                   
      | Refund            |

      | 7           | Partially Authorized | Transaction status after an
      approved `pre-authorization` request with the approved amount less than
      initially requested. Indicates that the issuer bank has approved only a
      portion of the requested payment amount. The exact authorized amount
      should be checked in the corresponding field. | Capture, Void     |

      | 8           | Informational        |
      NA                                                                                                                                                                                                                                                                                            
      | N/A               |

      | 21          | Scheduled            |
      NA                                                                                                                                                                                                                                                                                            
      | N/A               |

      | 24          | Pending              | Transaction status while changing
      status. This is a temporary
      status                                                                                                                                                                                                                          
      | N/A               |

      | 91          | Declined             | Transaction status after a denied
      `pre-authorization`, `sale` or `capture`
      request                                                                                                                                                                                                            
      | N/A               |

      | 92          | Failed               | Transaction status after a failure
      at any type of
      request                                                                                                                                                                                                                                     
      | N/A               |

      | 92          | Expired              | Transaction status after 7 days in
      `authorized` status (merchant has not captured within this
      time)                                                                                                                                                                                           
      | N/A               |

      </details>


      <details>

      <summary>Transaction Types</summary>

      <a id="flute-transaction-types"></a>


      | id | name               |

      |:--:|--------------------|

      | 1  | Authorization      |

      | 2  | Sale               |

      | 3  | Capture            |

      | 4  | Void               |

      | 5  | Refund             |

      | 6  | CardAuthentication |

      | 7  | RefundWORef        |

      | 8  | TipAdjustment      |

      | 11 | AchDebit           |

      | 12 | AchRefund          |

      | 13 | AchHold            |

      | 14 | AchUnHold          |

      | 15 | AchCancel          |

      | 16 | AchCredit          |

      </details>
  - name: Authorization
    description: >-
      <a id="generating-an-api-token"></a>

      An API token is required for each endpoint use.

      An API token can only be created after an account is created, registered,
      and at least one API key has been created.


      The API token is an authorization token needed for each endpoint.

      It is an encrypted string that combines the client Id and client secret
      from an API key (created earlier).

      It contains authentication and authorization coding.

      This includes any privileges the user or account affords.

      Being encrypted means the API token is safe to expose in frontend code.

      The API token is time-sensitive and expires after an amount of time.


      It may be created as needed.

      We recommend generating a new API token before each endpoint use.

      This ensures the API token will be valid for each call.


      <a id="baseOAuthURL"></a>

      The API token is an OAuth 2.0 Client Credentials authorization flow.

      The Client Credentials Flow is an OAuth 2.0 authorization Bearer grant.

      This means a server-side application obtains an access token using its
      client credentials (client ID and client secret) to protect resources.


      <h3 style="margin-top: 24px; margin-bottom: 4px;">Base authorization
      URLs</h3>

      An API token is created for the environment it will be used in.

      There are two available Flute environments: Sandbox and Production.


      **Sandbox**<br>

      Use the sandbox environment for development and testing.

      No payments, charges, or invoices will be enforced.<br>

      Endpoint: `POST https://sandbox.oauth.api.flute.com`


      **Production**<br>

      Use the production environment for deploying the payment system live to
      clients.

      All payments, charges, or invoices will be enforced.<br>

      Endpoint: `POST https://oauth.api.flute.com`


      The sandbox and production environments API tokens use the same API key
      and are differentiated only by the environment endpoint.

      The two API token types are not interchangeable and cannot be used in an
      environment different than they were created for.


      The API key that was created in the initial account registration is needed
      to create an API token.

      The **client ID** and **client secret** are used together to create an API
      token.


      The following is an example of obtaining an API token for the sandbox
      environment:

      ```shell

      curl -X 'POST' 'https://sandbox.oauth.api.flute.com/oauth2/token' \

      -u '594838709594...38697242c:9eb2c6859daa4...d8ae5da9' \

      -H 'Content-Type: application/x-www-form-urlencoded' \

      -d 'grant_type=client_credentials&scope=offline_access'

      ```


      The following is an example of refreshing an API token for the sandbox
      environment:

      ```shell

      curl -X 'POST' 'https://sandbox.oauth.api.flute.com/oauth2/token' \

      -u '594838709594...38697242c:9eb2c6859daa4...d8ae5da9' \

      -H 'Content-Type: application/x-www-form-urlencoded' \

      -d 'grant_type=refresh_token&refresh_token=def50200newrefresh123456789'

      ```


      Regardless of either obtaining or refreshing an API token, the following
      example is passed back in the response body:

      ```json

      {
        "access_token": "u7BYwJx26U1lT...TZpKvndLCC4",
        "refresh_token": "def50200newrefresh123456789",
        "token_type": "Bearer",
        "expires_in": 900
      }

      ```


      <h3 style="margin-top: 24px; margin-bottom: 4px;">Using the API Token</h3>


      The token endpoint returns both an `access_token` and a `refresh_token`.

      The lifespan of the `access_token` is indicated by the `expires_in` value.

      The lifespan of the `refresh_token` is set by OAuth standards.


      Clients are encouraged to use either token as needed.

      For example, it may be easier to call for a new `access_token` before each
      user-initiated action.

      The `access_token` may also be left to expire, and then use
      `refresh_token` procedures to continue.

      For example, mobile phones apps may need to use the `refresh_token` to
      avoid consistently signing back in.


      In the endpoint header, use the following `access_token` format:

      ```json

      "Authorization": "Bearer u7BYwJx26U1lT...TZpKvndLCC4"

      ```


      The following example creates a new access token:

      ```shell

      curl 'https://sandbox.api.flute.com/v2/transactions' \

      -H 'Authorization: Bearer u7BYwJx26U1lT...TZpKvndLCC44' \

      -H 'Accept: application/json'

      ```

      As a reminder, always secure your client ID and especially your client
      secret.

      Never expose the client secret in client-side code or public repositories.

      It should be kept private and secure.

      If it is suspected that the client secret has been compromised, the owning
      API key must be deleted.

      A new API key can then be created.


      <h3 style="margin-top: 24px; margin-bottom: 4px;">Error Responses</h3>


      If authentication fails, the token endpoint returns an error.

      The following are commonly encountered errors.


      | HTTP Status      | Common
      Cause                                                              |

      |------------------|---------------------------------------------------------------------------|

      | 400 Bad Request  | Missing or invalid grant_type, or malformed request
      body.                 |

      | 401 Unauthorized | The API token has likely expired. Create a new one
      and retry the request. |
  - name: ACH Transactions
    description: >
      <a id="ach-transactions"></a>

      The ACH (automated clearing house) transactions endpoints allow creating
      and managing ACH payments.


      These operations support initiating ACH debit and credit transactions,
      retrieving transaction details, and monitoring transaction status
      throughout processing.

      They also provide controls for managing transactions before settlement,
      such as placing transactions on hold, releasing holds, voiding pending
      transactions, or issuing refunds as needed.


      The following is a typical Flute ACH workflow.


      **Authorizing the Payment**<br>

      The customer authorizes the ACH payment.

      This includes obtaining NACHA-compliant authorization.

      NACHA (National Automated Clearing House Association) is the organization
      that governs the ACH payment network in the United States.

      It sets the rules and standards for ACH payments.


      The customer provides the SEC (standard entry class) code for the payment
      method.

      This establishes the form of payment.

      It can be one of the following:

      * Online form (SEC code WEB)

      * Signed authorization (SEC code PPD)

      * Phone authorization (SEC code TEL)

      * Business payment (SEC code CCD)


      And their personal information:

      * Name

      * Their bank's routing number

      * Their bank's account number and account type

      * Authorization confirmation


      **Creating the Payment**<br>

      The method can include either a credit or debit transaction:<br>

      `POST /pay-api/v1/transactions/ach/payment/credit`.<br>

      `POST /pay-api/v1/transactions/ach/payment`


      **Submitting the Payment**<br>

      Creating the ACH (automated clearing house) transaction also submits the
      request for processing.


      Flute aggregates transactions and sends them to the ODFI (originating
      bank) in an ACH (automated clearing house) transaction batch.

      ACH (automated clearing house) transactions are typically not processed
      individually but rather in as a batch of transactions.

      That processing is done by the ACH network and batches may take up to two
      days to clear.

      Therefore, there may be a delay in processing ACH (automated clearing
      house) transaction requests.

      An individual ACH (automated clearing house) transaction may be requested
      for same day processing.

      Settlement in those cases may occur within hours.

      Check with the originating bank for specific policies and fees.


      **Statusing the Payment**<br>

      Individual requests will always have an available status that can be
      checked.

      These will be noted with the <a href="#flute-transaction-statuses">Flute
      transaction creator type identifier</a>.


      A status check may be submitted at any time.

      Check the response field `status` or `statusId`.<br>

      `POST {{baseURL}}/pay-api/v1/transactions/{{transactionId}}`
            
      **Holding or Cancelling the Payment**<br>

      After the ACH (automated clearing house) transaction request has been
      successfully submitted, the transaction by the put on hold or cancelled.

      A transaction on hold means the request will not be processed.

      That transaction must either be released to continue processing or
      cancelled.<br>

      `POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/hold`<br>

      `POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/unhold`


      A transaction that is cancelled will be withdrawn from further processing.

      An ACH (automated clearing house) transaction request cannot be cancelled
      after it has been submitted to the ACH network.

      This is indicated by it's `pending` status.<br>

      `POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/void`


      **Settling the Payment**<br>

      If the ACH (automated clearing house) transaction request is successful,
      it returns with a status of `settled`.

      The merchant receives funds in their settlement account.

      The ACH (automated clearing house) transaction is completed.


      **Unsuccessfully Completing the Payment**<br>

      Banks can reject the payment with ACH return codes.

      Check the ACH return code for the specific reason.


      **Refunding the Payment**<br>

      Refunds may be issued.

      The ACH (automated clearing house) transaction request must have
      successfully been resolved and settled.<br>

      `POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/refund`
  - name: Customers
    description: >

      Customers are entities used to organize and manage saved payment methods.

      These include billing details, transaction history, and recurring
      payments.

      A customer record may contain their name, email address, phone number, and
      billing or shipping addresses.

      Having a customer association is not required to pay for
      transactions.      


      Customers may pay transactions in one of three ways:

      * Vaulted payments

      * Standalone tokenization, also known as orphan vaulted payment

      * Account supported


      **Vaulted payments**<br>

      A vaulted payment method is a securely stored payment credential.

      Customers can be associated with one or more vaulted payment methods.

      This applies to credit card or bank account payments.


      This is considered a more secure method rather than storing the card
      number directly.

      That information has previously been tokenized and saved for future use.

      Vaulted information can be safely accessed through a payment identifier.

      This is typically used for recurring billing, subscriptions, saved
      checkout experiences, and card-on-file transactions.


      In the transaction payment, the field `customerId` is provided.

      The customer's vaulted payment methods are available for selection.


      **Standalone tokenization**<br>

      Clients may use standalone tokenization, also known as an orphan vaulted
      payment.

      This allows a payment method to be vaulted even when the payer has not
      been recognized as a customer entity.

      The transaction proceeds using a previously established payment method
      identifier.


      Standalone tokenization is useful when a payment method must be vaulted
      before a customer profile exists.

      This includes guest checkouts, delayed onboarding, account setup, or
      card-on-file collection before registration is complete.


      In the transaction payment, the field `customerId` is omitted but
      `paymentMethodId` is provided.

      This indicates the merchant's orphan vaulted payment method is used.


      **Account Supported**<br>

      Clients may use accounts supporting orphan payments.

      This is a form of a payment method that temporarily exists without a
      customer association.


      In the transaction payment, both fields `customerId` and `paymentMethodId`
      are omitted.

      The transaction uses the credit or debit card, or bank account data
      supplied in the request.
  - name: MerchantApiTokens
  - name: Transactions
    description: >
      The Transactions endpoint group is the fundamental means of managing
      purchases and refunds.

      Transactions in general are separated into two divisions: **ACH
      transactions** and **cards transactions**.


      **ACH transactions** are payments processed through the ACH (automated
      clearing house) network.

      These are direct bank-to-bank transfers such as debits and credits.

      These transactions are typically processed in batches and settle or close
      within one to two business days.


      To complete an ACH (automated clearing house) transaction, see <a
      href="/api-reference/ach-transactions">ACH Transactions</a>.


      **Card transactions** are payments processed using a credit or debit card.

      These are processed through a card network such as Visa or Mastercard,
      among others.

      Card transaction operations support initiating the transaction, retrieving
      transaction details,

      and monitoring transaction status throughout processing.

      This processing has additional steps, such as verifying available funds,

      possibly declining the transaction request, holding the funds, and finally
      settling the request.


      **Capture**<br>

      Capture completes a previously authorized transaction and initiates the
      transfer of funds.

      This endpoint captures the authorized funds and completes the
      transaction:<br>

      `POST {{baseURL}}/pay-api/v1/transactions/capture`


      This is an example of the minimal request body.

      For example, the original authorization amount was $200. 

      the `amount` here must be $200.

      Any other value will fail the call.

      The `transactionId` is the `transactionId` from the Authorization endpoint
      above.<br>

      ```json

      {
          "amount": "200",
          "transactionId": "2f41c881-7337-45b9-8dba-fa5d9711e2b1"
      }

      ```


      Card transactions are separated into two operations: **One-step
      operations** and **two-step operations**.
        
      **One-step operations** are transactions that authorizes and captures the
      transaction in a single request.

      This allows processing a payment in one step or action by both approving
      the card and immediately completing the transaction.

      This is a common retail situation when the purchase price is finalized and
      known at the moment of the sale.


      **Two-step operations** are transactions that authorize and capture the
      transaction in separate requests.

      Common situations for this are:

      * A restaurant or hospitality situation

      The initial bill is known and a tip is added later

      The initial bill authorized and the funds held for a short while

      After the tip is added, the transaction is completed

      * An e-commerce or delayed fulfillment situation

      The purchase price is known but the customer order has a delay for
      fulfilment

      The purchase price is authorized but the funds are put on hold

      The transaction is completed when the item is shipped
        
      #### One-Step Operations Workflow

      The following procedure is for completing a one-step operation.


      Authenticate<br>

      Ensure a valid and current API token is available.

      This is generated from the partner or merchant API key.

      The API token is short-lived.

      The API token may be generated anew for the endpoint call, can use an
      previously generated API token that is still valid, or is using the
      refresh token.
        
      Submit a Payment Transaction<br>

      Use the following endpoint to initiate or submit the payment transaction.

      This endpoint combines authorization and capturing of a card transaction
      into one step.<br>

      `POST {{baseURL}}/pay-api/v1/transactions/sale`.
        
      This is an example of the return body, with the field `transactionId`
      noted.

      This field references the transaction for subsequent endpoints, if
      needed.<br>

      ```json

      {

      ...
        "transactionId": "69c71dd2-36c7-4b57-9467-3a03b171f741",
      ...

      }

      ```

      Automatic Processing<br>

      Flute receives the payment data from the endpoint.

      It routes the transaction to the processing center.

      The processor communicates with the customer's bank for approval or
      denial.

      It then relays the response back to the merchant site.
        
      The client's app gets back the transaction result.

      This includes whether it was approved or declined.

      The app handles either case directly.


      #### Two-Step Operations Workflow

      The following procedure is for completing a two-step operation.


      Authenticate<br>

      Ensure a valid and current API token is available.

      This is generated from the partner or merchant API key.

      The API token is short-lived.

      The API token may be generated anew for the endpoint call, can use an
      previously generated API token that is still valid, or is using the
      refresh token.


      Authorize<br>

      Use the following endpoint to authorize for the payment transaction.

      Authorizing a payment transaction, or request, confirms that the payment
      method is valid.

      If payment method is valid, it reserves, or puts a hold on, the funds.

      It does not actually move funds yet.

      The transaction can be rejected if the payment method is invalid and/or
      the requested funds are not available.
        
      This endpoint attempts to authorize the transaction:<br>

      `POST /pay-api/v1/transactions/auth`


      This is an example of the return body, with the field `transactionId`
      noted.

      This field references the transaction for subsequent endpoints, if
      needed.<br>

      ```json

      {

      ...
        "transactionId": "2f41c881-7337-45b9-8dba-fa5d9711e2b1",
      ...

      }

      ```
  - name: TransactionSettings
  - name: Subscription
    description: >
      A subscription is a recurring payment.

      The client authorizes a transaction at regular intervals, such as weekly,
      monthly, or annually.


      Examples include mortgages, leases, streaming media payments, and
      Insurance premiums.

      Payments represent:

      * **Recurring billing**. The transaction happens automatically on a set
      schedule without the client having to re-enter payment details.

      * **Pre-authorization**. The customer approves transactions for future
      charges.

      * **Fixed or variable amounts**. The transaction can be the same every
      cycle, such as for a streaming service or vary based on usage, such as a
      utility bill.

      * **Stored payment**. The transaction uses a vault or stored payment
      method.

      Payment methods include a credit or debit card (only sale transactions)
      and ACH electronic check.


      Installments may be specified as a combination of:

      * Days of the month, such as the 1st, 15th, or 30th

      * Weeks of the month, such as the first week or the third week

      * Months, such as 1 (January), 3 (March), or 12 (December)


      Installments may either specify:

      * A set number of payments, such as 36, 60, 360.

      For example, this may be for a mortgage or car payment.

      * Be indefinite and not specify an end date or a number of payments.

      For example, this may be for a streaming media subscription.


      The following endpoints are available:


      `GET /sub-api/v1/subscriptions`<br>

      Lists subscriptions associated with the merchant.


      `GET /sub-api/v1/subscriptions/{{subscriptionId}}`<br>

      Lists subscriptions associated with a specified subscription identifier.


      `POST /sub-api/v1/subscriptions`<br>

      Creates a subscription.


      `GET /sub-api/v1/subscriptions/{{subscriptionId}}/payments`<br>

      Lists the payment history from a specified subscription identifier.


      `PUT /sub-api/v1/subscriptions/{{subscriptionId}}/terminate`<br>

      Terminate or cancels the specified subscription identifier.
paths:
  /oauth2/token:
    post:
      tags:
        - Authorization
      summary: Obtains or refreshes an API token
      operationId: get-oauth-token
      description: >
        <span class="api-endpoint">POST {{<a
        href="#baseOAuthURL">baseOAuthURL</a>}}/oauth2/token</span>

        <a id="get-oauth-token"></a>


        This endpoint obtains or refreshes an API token.


        The resulting API token may be either a:

        * Merchant token if it is created from a merchant API key

        * Partner token if it is created from a partner API key


        For making an endpoint call, the two token types are neither the same
        nor interchangeable.

        The endpoint description specifies the required API key type.

        By default, a merchant API key is required.


        Obtaining a new API token or refreshing an existing one uses the same
        endpoint.

        However, body fields are different:

        * Obtaining a new API token uses:
          * `grant_type = client_credentials`
          * `scope = offline_access`
        * Refreshing an existing API token uses:
          * `grant_type = refresh_token`
          * adds the refresh token
          * does not use `scope`

        The examples below illustrate these request body fields.

        The differences are in bold.


        <table style="width: 100%;">
          <tr>
            <td style="border: 1pt solid black; padding: 5px; text-align: left; vertical-align: top;">
              Obtain token<br>
              Set the body type to `x-www-form-urlencoded`.<br><br>
              Body fields:<br>
              <b>grant_type = client_credentials</b><br>
              <b>scope = offline_access</b><br>
              client_id = u0LJUTc...BKhM3L<br>
              client_secret = eyJhbG...d7iXs
            </td>
            <td style="border: 1pt solid black; padding: 5px; text-align: left; vertical-align: top;">
              Refresh token<br>
              Set the body type to `x-www-form-urlencoded`.<br><br>
              Body fields:<br>
              <b>grant_type = refresh_token</b><br>
              <b>refresh_token = YhjQpM...EVkVuB</b><br>
              <s><b>scope = offline_access</b></s><br>
              client_id = u0LJUTc...BKhM3L-y<br>
              client_secret = eyJhbG...d7iXs
              </td>
          </tr>
        </table>
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - client_id
                - client_secret
                - grant_type
                - scope
              properties:
                client_id:
                  type: string
                  description: |
                    Specifies client ID from the API key for the account.

                    Example: 59483870959438697242c
                  example: 59483870959438697242c
                client_secret:
                  type: string
                  description: >
                    Specifies the client secret from the API key for the
                    account.


                    Example: 9eb2c6859daa4d8ae5da02a9
                  example: 9eb2c6859daa4d8ae5da02a9
                grant_type:
                  type: string
                  description: |
                    Specifies the literal value `client_credentials`.<br><br>

                    <span class="note">
                    If obtaining an API token, use: `client_credentials`<br>
                    If refreshing an API token, use: `refresh_token`
                    </span><br>

                    Example: client_credentials
                  example: client_credentials
                scope:
                  type: string
                  description: |
                    Specifies the literal value `offline_access`.<br><br>

                    <span class="note">
                    Use only for obtaining an API token.<br>
                    Omit when refreshing an API token.
                    </span><br>

                    Example: offline_access
                  example: offline_access
      responses:
        '200':
          description: OK. Access token issued successfully.
          content:
            application/json:
              schema:
                type: object
                required:
                  - access_token
                  - token_type
                properties:
                  access_token:
                    type: string
                    description: |
                      Indicates the API token.

                      Example: 213bf7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14
                    example: 213bf7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14
                  token_type:
                    type: string
                    description: |
                      Indicates the token type.

                      Example: Bearer
                    example: Bearer
                  expires_in:
                    type: integer
                    description: >
                      Indicates the expiry, or lifetime, (in seconds) of the API
                      token.


                      Example: 900
                    example: 900
                  refresh_token:
                    type: string
                    description: >
                      Indicates the refresh token (only for authorization_code
                      grant).


                      Example: 324c08b9-0c1d-4e2f-3a4b-5c6d7e8f9a25
                    example: 324c08b9-0c1d-4e2f-3a4b-5c6d7e8f9a25
                  scope:
                    type: string
                    description: |
                      Indicates the granted scopes, space-delimited.

                      Example: null
                    example: null
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/transactions/ach/payment/credit:
    post:
      tags:
        - ACH Transactions
      summary: Creates an ACH credit payment
      operationId: flute-v1-post-pay-api-transactions-ach-payment-credit
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/ach/payment/credit</span>


        This endpoint creates a credit ACH (automated clearing house)
        transaction to transfer funds from the merchant to the customer. 


        It specifically transfers money from the sender's bank account to the
        recipient's account.

        This is used in credit operations, such as payouts or refunds without
        reference.

        A refund without reference (also called unreferenced refunds) are
        refunds issued without linking it back to original receipt.


        <details>

        <summary>The following is an example of the minimum call.</summary>


        The endpoint call:

        ```html

        POST {{baseURL}}/pay-api/v1/transactions/ach/payment/credit

        ```

        The endpoint request body:

        ```json

        {
          "paymentProcessorId": "4acafddf-68a7-4aeb-9778-87582d121307",
          "paymentMethodId": "55419052-670c-497b-a53d-43d21ef45e14",
          "amount": 123.45,
          "secCode": 3,
          "RequesterIpAddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
        }

        ```

        </details>


        <span class="api-seealso">See Also:</span><br>

        To create an ACH debit transaction, see `POST
        /pay-api/v1/transactions/ach/payment`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.CreateAchRefundRequest
            examples:
              Credit (Refund / Payout):
                value:
                  paymentProcessorId: 7a913ba9-724b-4020-8ef1-d3375291f59e
                  paymentMethodId: d6e6a259-6e7f-4a8b-9c0d-1e2f3a4b5c81
                  accountNumber: null
                  routingNumber: null
                  customerId: null
                  requesterIPaddress: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                  amount: 123.45
                  isFasterProcessing: true
                  taxId: null
                  accountHolderType: 1
                  accountType: 1
                  billingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: null
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  shippingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: Office 7
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  contactInfo:
                    firstName: John
                    lastName: Smith
                    companyName: Flute
                    email: j.smith29f@example.com
                    mobilePhoneNumber: null
                    smsNotification: null
                  secCode: 3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse
              examples:
                Refund ACH Payment:
                  description: Valid parameters. Approved
                  value:
                    processedAmount: 0
                    transactionId: 5758166f-3608-4625-8dd6-04124a633581
                    typeId: 12
                    type: AchRefund
                    statusId: 23
                    status: ChargedBack
                    responseDescription: Command Successful. Approved.
                    responseCode: '000'
                Create ACH Payment:
                  description: Invalid parameters. Error.
                  value:
                    processedAmount: 0
                    transactionId: 0713a65a-6bab-4ae2-b687-5487f7749def
                    typeId: 11
                    type: AchDebit
                    statusId: 21
                    status: Scheduled
                    responseDescription: Invalid Gateway Credentials
                    responseCode: '100'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/transactions/ach/payment:
    post:
      tags:
        - ACH Transactions
      summary: Creates an ACH debit payment
      operationId: flute-v1-post-pay-api-transactions-ach-payment
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/ach/payment</span>


        This endpoint creates an ACH (automated clearing house) transaction to
        transfer funds from the customer to the merchant.


        It specifically transfers money from the customer's bank account to the
        merchant's account.


        <details>

        <summary>The following is an example of the minimum call.</summary>


        The endpoint call:

        ```html

        POST {{baseURL}}/pay-api/v1/transactions/ach/payment

        ```

        The endpoint request body:

        ```json

        {
          "paymentProcessorId": "7a913ba9-724b-4020-8ef1-d3375291f59e",
          "RequesterIpAddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
          "amount": 54.87,
          "secCode": 1,
          "accountHolderType": 1,
          "accountNumber": "123456789",
          "routingNumber": "123123123",
          "accountType": 1,
          "billingAddress": 
          {
              "city": "New York",
              "countryId": 1,
              "line1": "1234 Hudson Avenue",
              "postalCode": "10001",
              "stateName": "New York",
              "stateId": 25
          },
          "contactInfo": 
          {
              "firstName": "Alex",
              "lastName": "Morgan",
              "companyName": "Positive",
              "email": "a.morgan@example.com",
              "mobilePhoneNumber": '+14155554618'
          }
        }

        ```

        </details>


        <span class="api-seealso">See Also:</span><br>

        To create an ACH credit transaction, see `GET
        /pay-api/v1/transactions/ach/payment/credit`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.CreateAchPaymentRequest
            examples:
              Debit (Sale):
                value:
                  paymentProcessorId: b1390f80-724d-40e6-8790-80c5c7634ee0
                  paymentMethodId: d6e6a259-6e7f-4a8b-9c0d-1e2f3a4b5c81
                  accountNumber: null
                  routingNumber: null
                  customerId: null
                  requesterIPaddress: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
                  amount: 123.45
                  isFasterProcessing: true
                  taxId: null
                  accountHolderType: 1
                  accountType: 1
                  billingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: null
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  shippingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: Office 7
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  contactInfo:
                    firstName: John
                    lastName: Smith
                    companyName: Flute
                    email: j.smith29f@example.com
                    mobilePhoneNumber: null
                    smsNotification: null
                  secCode: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse
              examples:
                Create ACH Payment:
                  description: Valid parameters. Approved
                  value:
                    processedAmount: 0
                    transactionId: b3edb5a8-e235-4ef7-9003-2343b43c5c41
                    typeId: 11
                    type: AchDebit
                    statusId: 21
                    status: Scheduled
                    responseDescription: Command Successful. Approved.
                    responseCode: '000'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/ach/{transactionId}/void:
    post:
      tags:
        - ACH Transactions
      summary: Voids an ACH transaction
      operationId: flute-v1-post-pay-api-transactions-ach-id-void
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/ach/{{transactionId}}/void</span>


        This endpoint voids or cancels an ACH (automated clearing house)
        transaction payment before it is processed or submitted to the ACH
        network.


        After the transaction payment is submitted to the ACH network, it cannot
        be voided.


        <span class="api-seealso">See Also:</span><br>

        To refund a settled ACH transaction, see `POST
        /pay-api/v1/transactions/ach/{{transactionId}}/refund`<br>

        To place a hold on an ACH transaction, see `POST
        /pay-api/v1/transactions/ach/{{transactionId}}/hold`
      parameters:
        - $ref: '#/components/parameters/transaction_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse
              examples:
                Refund ACH Payment:
                  description: Valid parameters. Approved
                  value:
                    processedAmount: 0
                    transactionId: 4300da2c-8a00-48c2-bb9b-d84cf6313b7c
                    typeId: 15
                    type: AchDebit
                    statusId: 22
                    status: Cancelled
                    responseDescription: Command Successful. Approved.
                    responseCode: '000'
                Create ACH Payment:
                  description: Invalid parameters. Error.
                  value:
                    processedAmount: 0
                    transactionId: f3a3f17c-40cc-4979-a539-c208332a2579
                    typeId: 11
                    type: AchDebit
                    statusId: 21
                    status: Scheduled
                    responseDescription: Invalid Gateway Credentials
                    responseCode: '100'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/ach/{transactionId}/refund:
    post:
      tags:
        - v
      summary: Refunds an ACH transaction
      operationId: flute-v1-post-pay-api-transactions-ach-id-refund
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/ach/{{transactionId}}/refund</span>


        This endpoint refunds an ACH (automated clearing house) transaction
        payment that has already been settled.


        It sends money back to the original payer after the ACH payment has
        completed.


        <span class="api-seealso">See Also:</span><br>

        To void or cancel an ACH transaction that has not been settled, see
        `POST /pay-api/v1/transactions/ach/{{transactionId}}/void`<br>

        To place a hold on an ACH transaction, see `POST
        /pay-api/v1/transactions/ach/{{transactionId}}/hold`
      parameters:
        - $ref: '#/components/parameters/transaction_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse
              examples:
                Refund ACH Payment:
                  description: Valid parameters. Approved
                  value:
                    processedAmount: 0
                    transactionId: b4453ccb-be79-4a7c-b50d-96c52c1bfadf
                    typeId: 12
                    type: AchRefund
                    statusId: 23
                    status: ChargedBack
                    responseDescription: Command Successful. Approved.
                    responseCode: '000'
                Create ACH Payment:
                  description: Invalid parameters. Error.
                  value:
                    processedAmount: 0
                    transactionId: 4d33e47b-176e-475f-bf10-9f14e3668a48
                    typeId: 11
                    type: AchDebit
                    statusId: 21
                    status: Scheduled
                    responseDescription: Invalid Gateway Credentials
                    responseCode: '100'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/ach/{transactionId}/hold:
    post:
      tags:
        - ACH Transactions
      summary: Holds an ACH transaction
      operationId: flute-v1-post-pay-api-transactions-ach-id-hold
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/ach/{{transactionId}}/hold</span>


        This endpoint places an ACH (automated clearing house) transaction
        payment on hold.


        This is temporarily paused in processing.

        It is prevented from being processed or submitted to the ACH network
        until it is released.


        <span class="api-seealso">See Also:</span><br>

        To release an ACH transaction payment hold, see `POST
        /pay-api/v1/transactions/ach/{{transactionId}}/unhold`.<br>

        To void or cancel an ACH transaction that has not been settled, see
        `POST /pay-api/v1/transactions/ach/{{transactionId}}/void`
      parameters:
        - $ref: '#/components/parameters/transaction_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchResponse
              example:
                transactionId: 857757f3-9d2b-4204-abe6-c9d95bd41ec0
                typeId: 13
                type: AchHold
                statusId: 26
                status: Held
                responseDescription: null
                responseCode: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/ach/{transactionId}/unhold:
    post:
      tags:
        - ACH Transactions
      summary: Releases a held ACH transaction
      operationId: payapi_v1_transactions_ach_id_unhold
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/ach/{{transactionId}}/unhold</span>


        This endpoint removes an ACH (automated clearing house) transaction
        payment that is on hold.


        The ACH transaction resumes being processed and is submitted to the ACH
        network.


        <span class="api-seealso">See Also:</span><br>

        To place an ACH transaction payment on hold, see `POST
        //pay-api/v1/transactions/ach/{{transactionId}}/hold`
      parameters:
        - $ref: '#/components/parameters/transaction_id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchResponse
              example:
                transactionId: 65ab0547-8891-4719-956b-39fecaf41037
                typeId: 14
                type: AchUnHold
                statusId: 21
                status: Scheduled
                responseDescription: null
                responseCode: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/configurations/payments:
    get:
      tags:
        - Configurations
      summary: Lists payments configuration
      operationId: flute-v1-get-pay-api-configurations-payments
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/configurations/payments</span>


        This endpoint returns a list of payment configurations.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto
              example:
                zeroCostProcessingOptionId: 1
                zeroCostProcessingOption: null
                defaultTipsOptions: null
                defaultSurchargeRate: null
                defaultCashDiscountRate: null
                defaultDualPricingRate: null
                availableCurrencies:
                  - id: 1
                    name: USD
                availableCardTypes:
                  - id: 0
                    name: Unknown
                  - id: 1
                    name: Visa
                  - id: 2
                    name: MasterCard
                  - id: 3
                    name: AmericanExpress
                  - id: 4
                    name: DinersClub
                  - id: 5
                    name: Discover
                  - id: 6
                    name: JCB
                availableTransactionTypes:
                  - id: 2
                    name: Sale
                  - id: 3
                    name: Capture
                  - id: 5
                    name: Refund
                  - id: 4
                    name: Void
                  - id: 6
                    name: CardAuthentication
                  - id: 7
                    name: RefundWORef
                  - id: 8
                    name: TipAdjustment
                isTipsEnabled: true
                availablePaymentProcessors:
                  - id: 9e8d7c6b-5a4f-4e3d-b2c1-0a9b8c7d6e14
                    name: TSYS
                    isDefault: true
                    typeId: 0
                    type: null
                    settlementBatchTimeSlots:
                      - hours: 2
                        minutes: 10
                        timezoneName: America/New_York
                avs:
                  isEnabled: true
                  profileId: 1
                  profile: Strict
                isCustomerCardSavingByTerminalEnabled: false
                companyName: null
                mccCode: null
                mccCodeDescription: null
                currencyId: 1
                currencyIsoCode: null
                maxTransactionAmount: null
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/configurations/contact-infos:
    get:
      tags:
        - Configurations
      summary: Lists contact information
      operationId: flute-v1-get-pay-api-configurations-contact-infos
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/configurations/contact-infos</span>


        This endpoint returns the merchant's detailed information.


        The list includes contact information records for the merchant, such as
        address, phone number, and credit cards.

        This information can be integrated with other endpoints of the
        application, such as the invoice creation functionality.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/customers:
    get:
      tags:
        - Customers
      summary: Lists customers
      operationId: pay_api_v1_search_customers
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers</span>


        This endpoint lists the partner's customers.


        The search can specify filters to better target intended customers.


        <span class="api-seealso">See Also:</span><br>

        To find a customer by identifier, see `GET
        /pay-api/v1/customers/{{customerId}}`.<br>

        To create a customer, see `POST /pay-api/v1/customers`.<br>

        To delete a customer, see `DELETE
        /pay-api/v1/customers/{{customerId}}`.<br>

        To update a customer's information, see `PUT
        /pay-api/v1/customers/{{customerId}}`.


        <span style="font-size: 9pt;">
          Navigation: 
          [ <span style="color: #999;">Headers</span> ]
          [ <a href="#pay_api_v1_customers_parameters">Query</a> ]
          [ <span style="color: #999;">Request body</span> ]
          [ <a href="#pay_api_v1_customers_response">Response body</a> ]
          [ <a href="#pay_api_v1_customers_errors">Response codes</a> ]
        </span>

        <a id="pay_api_v1_customers_parameters"></a>
      parameters:
        - name: search
          in: query
          description: >
            Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.


            firstName<br>

            lastName<br>

            companyName<br>

            email<br>

            mobilePhoneNumber<br>

            id<br>

            createdOn<br>

            lastTransactionDate<br>

            contactName
          schema:
            type: string
            example: Conners Electric
        - name: customerIds
          in: query
          description: |
            Specifies a single customer's identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: dateFrom
          in: query
          description: >
            Specifies returning items on or after this date (in an ISO 8601
            date-time format).


            If `dateFrom` only is specified, the search returns all available
            items from the `dateFrom` value to the present.

            The fields `dateFrom` and `dateTo` may be used together to create an
            exclusive range.

            We recommend creating an exclusive range to avoid a potentially
            excessive number of returns.
          schema:
            type: string
            format: date-time
            example: '2025-01-27T12:05:54.322587Z'
        - name: dateTo
          in: query
          description: >
            Specifies returning items on or to this date (in an ISO 8601
            date-time format).


            If `dateTo` only is specified, the search returns all available
            items up to the `dateTo` value.

            The fields `dateFrom` and `dateTo` may be used together to create an
            exclusive range.

            We recommend creating an exclusive range to avoid a potentially
            excessive number of returns.
          schema:
            type: string
            format: date-time
            example: '2026-01-27T12:05:54.322587Z'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
      responses:
        '200':
          description: OK <a id="pay_api_v1_customers_response"></a>
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.GetPage.GetCustomerPageResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
        - Customers
      summary: Creates a customer
      operationId: pay_api_v1_customers
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers</span>


        This endpoint creates a customer.


        The return field `id` is the customerId, also referred to as the
        *customer identifier*.

        Use this value to specify this customer in other endpoints.


        <span class="api-seealso">See Also:</span><br>

        To search for a customer, see `GET /pay-api/v1/customers`<br>

        To find a customer by identifier, see `GET
        /pay-api/v1/customers/{{customerId}}`.<br>

        To update a customer's information, see `PUT
        /pay-api/v1/customers/{{customerId}}`.
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.Create.CreateCustomerRequest
            example:
              firstName: George
              lastName: Black
              companyName: Peppared Street Cafe
              email: pepparedstreetcafe@eaxample.com
              mobilePhoneNumber: '+14155554618'
              isMobileNumberSmsNotificationsEnabled: true
              useBillingAsShippingAddress: false
              billingAddress:
                addressLine1: 7429 Desert Mirage Lane
                addressLine2: Office 7
                city: Phoenix
                zip: 60612-0001
                stateName: Illinois
                stateId: 4
                countryId: 1
              shippingAddress:
                addressLine1: 7429 Desert Mirage Lane
                addressLine2: Office 7
                city: Phoenix
                zip: 60612-0001
                stateName: Illinois
                stateId: 4
                countryId: 1
              paymentMethodsCards:
                - name: Payment_method1
                  pan: '444466666655555'
                  expirationMonth: 1
                  expirationYear: 2032
                  securityCode: '345'
                - name: Payment_method2
                  pan: '1234567890123'
                  expirationMonth: 4
                  expirationYear: 25
                  securityCode: null
              paymentMethodsAchAccounts: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.Create.CreateCustomerResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/customers/{customerId}:
    get:
      tags:
        - Customers
      summary: Retrieves a customer by ID
      operationId: pay_api_v1_get_customers_{customerId}
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}</span>


        This endpoint retrieves the specified customer.


        <span class="api-seealso">See Also:</span><br>

        To search for a customer, see `GET /pay-api/v1/customers`<br>

        To update a customer's information, see `PUT
        /pay-api/v1/customers/{{customerId}}`.<br>

        To create a customer, see `POST /pay-api/v1/customers`.<br>

        To delete a customer, see `DELETE /pay-api/v1/customers/{{customerId}}`.
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies the customerId, also known as the customer identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.Get.GetCustomerResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    put:
      tags:
        - Customers
      summary: Updates a customer's information
      operationId: pay_api_v1_update_customers_{customerId}
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}</span>


        This endpoint updates a customer's information.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>


        <span class="api-seealso">See Also:</span><br>

        To search for a customer, see `GET /pay-api/v1/customers`.<br>

        To find a customer by identifier, see `GET
        /pay-api/v1/customers/{{customerId}}`.<br>

        To create a customer, see `POST /pay-api/v1/customers`.<br>

        To delete a customer, see `DELETE /pay-api/v1/customers/{{customerId}}`.
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies the customerId, also known as the customer identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.Update.UpdateCustomerRequest
            example:
              firstName: Alexandro
              lastName: Peppared
              companyName: Peppared Street Cafe
              email: pepparedstreetcafe@eaxample.com
              mobilePhoneNumber: '+14155554618'
              isMobileNumberSmsNotificationsEnabled: true
              useBillingAsShippingAddress: false
              billingAddress:
                addressLine1: 7429 Desert Mirage Lane
                addressLine2: Office 7
                city: Chicago
                zip: 60612-0001
                stateName: Illinois
                stateId: 8
                countryId: 1
              shippingAddress:
                addressLine1: 7429 Desert Mirage Lane
                addressLine2: Office 7
                city: Phoenix
                zip: 60612-0001
                stateName: Illinois
                stateId: 8
                countryId: 1
      responses:
        '200':
          description: OK
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    delete:
      tags:
        - Customers
      summary: Deletes a customer
      operationId: pay_api_v1_delete_customers_{customerId}
      description: >
        <span class="api-endpoint">DELETE {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}</span>


        This endpoint deletes the specified customer.


        <span class="api-seealso">See Also:</span><br>

        To search for a customer, see `GET /pay-api/v1/customers`<br>

        To update a customer's information, see `PUT
        /pay-api/v1/customers/{{customerId}}`<br>

        To create a customer, see `POST /pay-api/v1/customers`<br>

        To delete a customer, see `DELETE /pay-api/v1/customers/{{customerId}}`
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies the customerId, also known as the customer identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
      responses:
        '200':
          description: OK. The customer was successfully deleted.
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/customers/{customerId}/payment-methods/cards:
    post:
      tags:
        - Customers
      summary: Creates a card payment method
      operationId: pay_api_v1_customers_{customerId}_payment_methods_cards
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}/payment-methods/cards</span>


        This endpoint adds a payment method for credit and debit cards.
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies the customerId, also known as the customer identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodRequest
            example:
              name: Payment_method
              pan: '444466666655555'
              expirationMonth: 1
              expirationYear: 2032
              securityCode: '345'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/customers/{customerId}/payment-methods/ach:
    post:
      tags:
        - Customers
      summary: Creates an ACH payment method
      operationId: pay_api_v1_customers_{customerId}_payment_methods_ach
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}/payment-methods/ach</span>


        This endpoint creates a payment method for EFT or ACH (automated
        clearing house) transactions.


        <details>

        <summary>The following is an example of the minimum call.</summary>


        The endpoint call, with a fictitious customerId:

        ```html

        POST
        {{baseURL}}/pay-api/v1/customers/019d2135-be3f-7310-8e03-0bece14c231b/payment-methods/ach

        ```

        The endpoint request body:

        ```json

        {
          "paymentMethodId": "123456789",
          "routingNumber": "123123123",
          "accountType": 1,
          "accountHolderType": 1
        }

        ```

        The return value is the paymentMethodId (payment method identifier).

        ```json

        {
          "id": "ecb05a38-990a-46fb-9a37-b0359164d918"
        }

        ```

        </details>


        <span class="api-seealso">See Also:</span><br>

        To add a payment method for other transaction types, see `GET
        /pay-api/v1/customers/{{customerId}}/payment-methods`<br>

        To update a payment method, see `PUT
        /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`<br>

        To delete a payment method, see `DELETE
        /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`<br>

        To set a default payment method, see `PUT
        /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default`<br>
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies a single customer's identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Ach.Create.CreateAchAccountPaymentMethodRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: |
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/customers/{customerId}/payment-methods:
    get:
      tags:
        - Customers
      summary: Lists a customer's payment methods
      operationId: pay_api_v1_customers_{customerId}_payment_methods
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}/payment-methods</span>


        This endpoint lists a customer's payment methods.
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies a customer's identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
        - name: search
          in: query
          description: >
            Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.
          schema:
            type: string
            example: Conners Electric
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: dateFrom
          in: query
          description: >
            Specifies returning items on or after this date (in an ISO 8601
            date-time UTC format).


            If `dateFrom` only is specified, the search returns all available
            items from the `dateFrom` value to the present.

            The fields `dateFrom` and `dateTo` may be used together to create an
            exclusive range.

            We recommend creating an exclusive range to avoid a potentially
            excessive number of returns.
          schema:
            type: string
            format: date-time
            example: '2025-01-27T12:05:54.322587Z'
        - name: dateTo
          in: query
          description: >
            Specifies returning items on or to this date (in an ISO 8601
            date-time UTC format).


            If `dateTo` only is specified, the search returns all available
            items up to the `dateTo` value.

            The fields `dateFrom` and `dateTo` may be used together to create an
            exclusive range.

            We recommend creating an exclusive range to avoid a potentially
            excessive number of returns.
          schema:
            type: string
            format: date-time
            example: '2026-01-27T12:05:54.322587Z'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Contracts.Page.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
  /pay-api/v1/customers/{customerId}/payment-methods/{paymentMethodId}:
    put:
      tags:
        - Customers
      summary: Updates a payment method
      operationId: pay_api_v1_put_customers_{customerId}_payment_methods_{paymentMethodId}
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}</span>


        This endpoint updates the specified customer's payment method.


        Only the payment method name may be changed with this endpoint.

        If a different payment method type is required, a new payment method
        identifier must be created.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>


        <span class="api-seealso">See Also:</span><br>

        To add a EFT or ACH payment method for EFT or ACH transactions, see
        `POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach`<br>

        To list a customer payment methods, see `GET
        /pay-api/v1/customers/{{customerId}}/payment-methods`<br>

        To delete a payment method, see `DELETE
        /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`<br>

        To set a default payment method, see `PUT
        /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default`
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies the customerId, also known as the customer identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
        - name: paymentMethodId
          in: path
          required: true
          description: |
            Specifies the payment method identifier.
          schema:
            type: string
            format: uuid
            example: 46e5de89-a9f0-4d79-9350-b612bfa3c5ee
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Update.UpdatePaymentMethodRequest
            example:
              name: Payment_Method
      responses:
        '200':
          description: OK. The payment method was successfully updated.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: |
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
    delete:
      tags:
        - Customers
      summary: Deletes a payment method
      operationId: >-
        pay_api_v1_delete_customers_{customerId}_payment_methods_{paymentMethodId}
      description: >
        <span class="api-endpoint">DELETE {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}</span>


        This endpoint deletes the specified payment method.


        <span class="api-seealso">See Also:</span><br>

        To add a EFT or ACH payment method for EFT or ACH transactions, see
        `POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach`<br>

        To add a payment method for other transaction types, see `GET
        /pay-api/v1/customers/{{customerId}}/payment-methods`<br>

        To update a payment method, see `PUT
        /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies the customerId, also known as the customer identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
        - name: paymentMethodId
          in: path
          required: true
          description: |
            Specifies the payment method identifier.
          schema:
            type: string
            format: uuid
            example: 46e5de89-a9f0-4d79-9350-b612bfa3c5ee
      responses:
        '200':
          description: OK. The payment method was successfully deleted.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: |
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-api/v1/customers/{customerId}/payment-methods/{paymentMethodId}/make-default:
    put:
      tags:
        - Customers
      summary: Sets a default payment method
      operationId: >-
        pay_api_v1_customers_{customerId}_payment_methods_{paymentMethodId}_make_default
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}/make-default</span>


        This endpoint sets the specified payment method as the default.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>


        <span class="api-seealso">See Also:</span><br>

        To add a EFT or ACH payment method for EFT or ACH transactions, see
        `POST /pay-api/v1/customers/{{customerId}}/payment-methods/ach`<br>

        To add a payment method for other transaction types, see `GET
        /pay-api/v1/customers/{{customerId}}/payment-methods`<br>

        To update a payment method, see `PUT
        /pay-api/v1/customers/{{customerId}}/payment-methods/{{paymentMethodId}}`
      parameters:
        - name: customerId
          in: path
          required: true
          description: |
            Specifies the customerId, also known as the customer identifier.
          schema:
            type: string
            format: uuid
            example: c4b210e9-be39-4ebc-8195-0c422de87f90
        - name: paymentMethodId
          in: path
          required: true
          description: |
            Specifies the payment method identifier.
          schema:
            type: string
            format: uuid
            example: 46e5de89-a9f0-4d79-9350-b612bfa3c5ee
      responses:
        '200':
          description: OK. The payment method was successfully added as the default.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-api/v1/devices:
    get:
      tags:
        - Devices
      summary: Retrieves devices
      operationId: pay_api_v1_get_devices
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/devices</span>


        This endpoint retrieves the list of registered devices.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.GetDevicesResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
    post:
      tags:
        - Devices
      summary: Creates or updates a device by ID
      operationId: pay_api_v1_create_devices
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/devices</span>
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.CreateOrUpdate.CreateOrUpdateDeviceRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.CreateOrUpdate.CreateOrUpdateDeviceResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/devices/{deviceId}:
    get:
      tags:
        - Devices
      summary: Retrieves a device by ID
      operationId: pay_api_v1_devices_{deviceId}
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/devices/{{deviceId}}</span>


        This endpoint retrieves the specified device.
      parameters:
        - name: deviceId
          in: path
          required: true
          description: |
            <br>Specifies the device identifier.
          schema:
            type: string
            format: uuid
            example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1454
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
  /pay-api/v1/devices/tap-to-pay/jwt:
    post:
      tags:
        - Devices
      summary: Generates a tap-to-pay token by device by ID
      operationId: pay_api_v1_devices_tap_to_pay_jwt
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/devices/tap-to-pay/jwt</span>
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.TapToPay.GenerateTapToPayJwtRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.TapToPay.GenerateTapToPayJwtResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-api/v1/devices/{deviceId}/tap-to-pay/activate:
    post:
      tags:
        - Devices
      summary: Activates tap-to-pay functionality by device ID
      operationId: pay_api_v1_devices_{deviceId}_tap_to_pay_activate
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/devices/{{deviceId}}/tap-to-pay/activate</span>
      parameters:
        - name: deviceId
          in: path
          required: true
          description: |
            <br>Specifies the device identifier.
          schema:
            type: string
            format: uuid
            example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1454
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
  /pay-api/v1/merchants:
    get:
      tags:
        - Merchant API Keys
      summary: Lists merchants
      operationId: flute-v1-get-pay-api-merchants
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/merchants</span>


        This endpoint lists merchants associated with the authenticated partner
        (ISV).


        The following query parameters are search filters used to specify the
        retuurned results.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: search
          in: query
          required: false
          description: >
            Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.
          schema:
            type: string
            example: Pappared
        - name: mccCodeId
          in: query
          required: false
          description: |
            Specifies the <a href="#mcc-codes">MCC (merchant category code)</a>.

            Example: 28
          schema:
            type: integer
            format: int32
            example: 28
        - name: statusId
          in: query
          required: false
          description: Merchant status filter.
          schema:
            type: integer
            format: int32
        - name: createdFrom
          in: query
          required: false
          description: >
            Specifies the earliest inclusive created date (in an ISO 8601
            date-time UTC format).


            This value may be paired with the field `createdTo` to form an
            inclusive range.
          schema:
            type: string
            format: date-time
            example: '2026-02-19T20:24:52.934Z'
        - name: createdTo
          in: query
          required: false
          description: >
            Specifies the latest inclusive created date (in an ISO 8601
            date-time UTC format).


            This value may be paired with the field `createdFrom` to form an
            inclusive range.
          schema:
            type: string
            format: date-time
            example: '2026-03-06T14:24:52.934Z'
        - name: modifiedFrom
          in: query
          required: false
          description: >
            Specifies the earliest inclusive modified date (in an ISO 8601
            date-time UTC format).


            This value may be paired with the field `modifiedTo` to form an
            inclusive range.
          schema:
            type: string
            format: date-time
            example: '2026-02-19T20:24:52.934Z'
        - name: modifiedTo
          in: query
          required: false
          description: >
            Specifies the latest inclusive modified date (in an ISO 8601
            date-time UTC format).


            This value may be paired with the field `modifiedFrom` to form an
            inclusive range.
          schema:
            type: string
            format: date-time
            example: '2026-03-06T14:24:52.934Z'
        - name: lastTransactionDateFrom
          in: query
          required: false
          description: >
            Specifies the earliest inclusive transaction date (in an ISO 8601
            date-time UTC format).


            This value may be paired with the field `lastTransactionDateTo` to
            form an inclusive range.
          schema:
            type: string
            format: date-time
            example: '2026-02-19T20:24:52.934Z'
        - name: lastTransactionDateTo
          in: query
          required: false
          description: >
            Specifies the latest inclusive transaction date (in an ISO 8601
            date-time UTC format).


            This value may be paired with the field `lastTransactionDateFrom` to
            form an inclusive range.
          schema:
            type: string
            format: date-time
            example: '2026-03-06T14:24:52.934Z'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                required:
                  - items
                  - total
                properties:
                  items:
                    type: array
                    description: |
                      Indicates an object array for the returned merchant list.
                    items:
                      type: object
                      properties:
                        companyName:
                          type: string
                          description: >
                            Indicates the name of the customer's company or
                            organization.


                            Example: Peppared Street Cafe
                          example: Peppared Street Cafe
                        merchantId:
                          type: string
                          description: |
                            Indicates the merchant Identifies.

                            Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          format: uuid
                      required:
                        - merchantId
                        - companyName
                  total:
                    type: integer
                    format: int32
                    description: |
                      Indicates the total number of merchants found.

                      Example: 4
                    example: 4
              example:
                items:
                  - merchantId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    companyName: Peppared Street Cafe
                total: 1
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/merchants/tokens:
    get:
      tags:
        - Merchant API Keys
      summary: Lists merchant API keys
      operationId: flute-v1-get-pay-api-merchants-tokens
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/merchants/tokens</span>


        This endpoint lists merchant API keys created for merchants under a
        partner account.


        The query parameter filter may be used to further specify API keys to
        return.


        This endpoint requires the API token to be from a partner API key.

        API tokens generated from a merchant key are not accepted.
      parameters:
        - name: merchantId
          in: query
          description: |
            Specifies the identifier of the merchant.

            If null or omitted, all merchants from the partner aer returned.
          schema:
            type: string
            format: uuid
            example: 46063d32-10fa-44cb-b118-20ddd085ce3f
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
        - Merchant API Keys
      summary: Creates a merchant API key
      operationId: flute-v1-post-pay-api-merchants-tokens
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/merchants/tokens</span>


        This endpoint creates an API key for a merchant managed by their partner
        account.


        Provide the Merchant ID and a API key name to generate a client Id and
        client secret for the merchant.


        Use the returned credentials to authenticate as the merchant for API
        operations.


        This endpoint requires the API token to be from a partner API key.

        API tokens generated from a merchant key are not accepted.
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.CreateMerchantApiTokenRequestDto
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.CreateMerchantApiTokenResponseDto
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/merchants/tokens/{clientId}:
    delete:
      tags:
        - Merchant API Keys
      summary: Revokes a merchant API key
      operationId: flute-v1-delete-pay-api-merchants-tokens-clientId
      description: >
        <span class="api-endpoint">DELETE {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/merchants/tokens/{{clientId}}</span>


        This endpoint revokes an API key associated with a merchant under their
        partner account.


        This action revokes the token and prevents further API access using
        those credentials.


        This endpoint requires the API token to be from a partner API key.

        API tokens obtained from a merchant key are not accepted.
      parameters:
        - name: clientId
          in: path
          description: The client ID of the token to be removed.
          required: true
          schema:
            type: string
            format: uuid
        - name: merchantId
          in: query
          description: |
            Specifies the identifier of the merchant.
          schema:
            type: string
            format: uuid
            example: 46063d32-10fa-44cb-b118-20ddd085ce3f
      responses:
        '200':
          description: OK. The API key was successfully deleted.
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/settlements/batches:
    get:
      tags:
        - Settlement Batches
      summary: Lists transaction batch settlements
      operationId: flute-v1-get-pay-api-settlements-batches
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/settlements/batches</span>
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: dateFrom
          in: query
          description: >
            Specifies returning items on or after this date (in an ISO 8601
            date-time format).


            If `dateFrom` only is specified, the search returns all available
            items from the `dateFrom` value to the present.

            The fields `dateFrom` and `dateTo` may be used together to create an
            exclusive range.

            We recommend creating an inclusive range to avoid a potentially
            excessive number of returns.
          schema:
            type: string
            format: date-time
            example: '2025-01-27T12:05:54.322587Z'
        - name: dateTo
          in: query
          description: >
            Specifies returning items on or to this date (in an ISO 8601
            date-time format).


            If `dateTo` only is specified, the search returns all available
            items up to the `dateTo` value.

            The fields `dateFrom` and `dateTo` may be used together to create an
            exclusive range.

            We recommend creating an inclusive range to avoid a potentially
            excessive number of returns.
          schema:
            type: string
            format: date-time
            example: '2026-01-27T12:05:54.322587Z'
        - name: batchIds
          in: query
          description: >
            <br>Specifies the payment identifiers included in the batch
            settlement.
          schema:
            type: array
            items:
              type: string
              format: uuid
              example:
                - 345cd3e4-5f6a-4b7c-8d9e-0f1a2b3c4d70
                - 456de4f5-6a7b-4c8d-9e0f-1a2b3c4d5e81
        - name: paymentProcessorIds
          in: query
          schema:
            type: array
            description: >
              <br>Specifies the payment processor identifiers handling the batch
              settlement.
            items:
              type: string
              format: uuid
              example:
                - 123ab1c2-3d4e-4f5a-6b7c-8d9e0f1a2b58
                - 234bc2d3-4e5f-4a6b-7c8d-9e0f1a2b3c69
        - name: statusId
          in: query
          description: |
            Specifies the settlement batch status.

            Possible values:

            | Status | Description |
            |:-----: |-------------|
            | 1      | Open        |
            | 2      | Settled     |
          example: 1
          schema:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Enums.SettlementBatchStatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Contracts.Page.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse
  /pay-api/v1/transactions:
    get:
      tags:
        - Transactions
      summary: Lists process transactions
      operationId: flute-v1-get-pay-api-transactions
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions</span>


        This endpoint returns a list of transactions details.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: createMethodId
          in: query
          description: >
            Specifies the <a href="#flute-transaction-creator-type">Flute ACH
            transaction creator type identifier</a>.


            Example: 3
          schema:
            type: integer
            format: int32
            example: 3
        - name: createdById
          in: query
          description: |
            Specifies the transaction creator's identifier.

            Example: 109fb6fb-91bf-442a-a9cb-051255ff72b0
          schema:
            type: string
            format: uuid
            example: 109fb6fb-91bf-442a-a9cb-051255ff72b0
        - name: batchId
          in: query
          description: >
            Specifies the identifier assigned to the batch that contains one or
            more ACH (automated clearing house) transactions.


            Example: 44a56eab-82c8-46de-bc07-021371be4721
          schema:
            type: string
            format: uuid
            example: 44a56eab-82c8-46de-bc07-021371be4721
        - name: noBatch
          in: query
          description: >
            Specifies the transaction should bypass normal ACH (automated
            clearing house) batching.


            The transaction will be processed individually instead of being
            grouped with other ACH transactions.


            If `true`, the transaction will be processed individually instead of
            being grouped with other ACH transactions.<br>

            If `false`, the transaction will be not processed individually but
            will be grouped with other ACH transactions.


            Example: false
          schema:
            type: boolean
            example: false
            default: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Contracts.Page.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse
              examples:
                Get transactions for terminal:
                  description: Total = amount of items, Items = transactions list value
                  value:
                    total: 16
                    items:
                      - id: 29de5986-c7f6-4100-a06b-3f686912d1f7
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.333986Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e25
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: john@example.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: afbf5d22-2415-4092-8329-b06073c71b24
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 552cb98d-0290-44e6-8c7c-a72120254b6d
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340022Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: 5d6e7f8a-9b0c-4d1e-a2b3-4c5d6e7f8a3
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 2
                        customerEmail: john@example.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: 2f844bdd-9909-4032-84a8-86f7ef552104
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 58a51103-66a0-45e2-90b7-73be91099acf
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340065Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: 7a8b9c0d-1e2f-4a3b-b4c5-6d7e8f9a0b47
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: john@example.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: 65244302-eb98-4b6e-988f-683cf982eef2
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 1278544f-1de7-450a-9e01-7813109ed384
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340106Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: 0f1e2d3c-4b5a-4c6d-a7b8-9c0d1e2f3a58
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: john@example.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: c68f7446-e98e-402f-a51b-7b13a7fadd4f
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 77a1802c-9142-4e9f-882e-bbb30775f450
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340153Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: 4c5d6e7f-8a9b-4c0d-b1e2-3f4a5b6c7d69
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: john@example.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: b1060c57-cffa-45ff-8cc0-881b7faea27d
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: a3ee8fde-3760-4083-967c-6422197873bf
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340195Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f03
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: b0ae7792-7c10-43e2-9390-04bd7c546289
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: e8558f26-9242-438f-86cc-54e9a36deff5
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340239Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: cd97928e-7f02-47fa-88df-6d652b57f416
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 8c526ade-3fc4-40d0-a168-458ef1d513cc
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340281Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 2
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: f5cef7ba-76b5-47af-8732-9eeefd0c5515
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 0d8abb05-1684-46ec-a8ef-a86f1f868630
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340322Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 2
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: 8eb5f348-caf6-4f73-bb31-c7b2962595bd
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 242f3908-6588-4351-bb92-5e91df319e06
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340358Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: 03d9f39b-3fa4-4adb-a5d5-d079079c33b3
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 635e5351-09a9-4cb0-8a77-172456ebe823
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340397Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 2
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: 552d6292-af5d-44fa-a173-563e08814e37
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: ed36b508-b702-4425-8b0f-dc71c6e840a2
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340437Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: 3c5294d1-ef42-4b1b-bfcc-25e22b5d11ef
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 8e159fea-aff2-4124-9da8-d4941f0b1824
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340506Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: ceb7d3ba-c74e-460c-a279-5884df767316
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 51fbfefb-3ace-493f-93c3-1bef1cf65692
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3340663Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 1
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: 0094b6c4-4224-4427-b43e-94e6bb18033b
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: 809d0d5a-199a-4dcf-bb08-a90cbaee7bd1
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.334097Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 2
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: 75e63e0a-6171-44f1-b553-280dadc575de
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
                      - id: a4a491e8-8091-458e-be19-f1239e21405f
                        paymentProcessorId: b40e4e57-33b2-45c9-ba78-2e54837f8f48
                        date: '2025-12-16T10:35:52.3341016Z'
                        baseAmount: 1.1
                        totalAmount: 1.1
                        surchargeAmount: 0
                        surchargePercentage: 0
                        currencyCode: USD
                        currencyId: 1
                        merchant: Merchant
                        merchantId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                        operationMode: null
                        paymentMethodType: Card
                        paymentMethodTypeId: 1
                        paymentMethodName: Cafe Peppared
                        customerName: John
                        customerCompany: Company
                        customerPan: '************4512'
                        cardTokenType: 2
                        customerEmail: e@mail.com
                        customerPhone: '+12105554618'
                        status: Captured
                        statusId: 2
                        typeId: 3
                        type: Capture
                        batchId: null
                        source:
                          typeId: 1
                          type: Portal
                          id: d2e1e4af-a8fe-4bf2-8ec3-6d3c24e30add
                          name: SourceName
                        availableOperations:
                          - typeId: 4
                            type: Void
                            availableAmount: 1.1
                            suggestedTips: null
                        amount: null
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/transactions/{id}:
    get:
      tags:
        - Transactions
      summary: Retrieves a transaction by ID
      operationId: flute-v1-get-pay-api-transactions-id
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/{{transactionId}}</span>


        This endpoint retrieves a specified transaction details.


        <span class="api-seealso">See Also:</span><br>

        To return a list of transactions, see `POST /pay-api/v1/transactions`
      parameters:
        - name: transactionId
          in: path
          required: true
          description: |
            Specifies the transaction identifier.
          schema:
            type: string
            format: uuid
            example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse
              example:
                baseAmount: 100
                totalAmount: 100
                tsysCardDetails:
                  authCode: A0000
                  mid: '222222222'
                  tid: '1000001'
                achDetails:
                  customerAccountNumber: null
                  customerRoutingNumber: null
                  accountHolderType: null
                  accountHolderTypeId: 0
                  accountType: null
                  accountTypeId: 0
                  taxId: null
                transactionId: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d81
                transactionDateTime: '2025-12-15T10:35:52.5407322Z'
                amount:
                  baseAmount: 100
                  percentageOffAmount: 0
                  percentageOffRate: 0
                  cashDiscountAmount: 0
                  cashDiscountRate: 0
                  surchargeAmount: 0
                  surchargeRate: 0
                  tipAmount: 0
                  tipRate: 0
                  totalAmount: 100
                currencyId: 1
                currency: USD
                processorId: c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e92
                processor: TSYS Sample
                operationTypeId: 1
                operationType: PayNow
                paymentMethodTypeId: 1
                paymentMethodType: Card
                transactionTypeId: 1
                transactionType: Authorization
                customerId: null
                customerPan: '************4512'
                cardTokenType: 1
                statusId: 1
                status: Authorized
                merchantName: Your Company
                merchantAddress: WallStreet 1, New York
                merchantPhoneNumber: '1555123123'
                merchantEmailAddress: support@company.com
                merchantWebsite: ''
                authCode: A0000
                source:
                  typeId: 1
                  type: Portal
                  id: 7b592aea-b3bd-4ac1-a1e6-c63c5080554e
                  name: SourceName
                cardholderAuthenticationMethodId: null
                cardholderAuthenticationMethod: null
                cvmResultMsg: null
                cardDataSourceId: null
                cardDataSource: null
                responseCode: null
                responseDescription: null
                cardProcessingDetails:
                  authCode: A0000
                  mid: '222222222'
                  tid: '1000001'
                  cardCreditDebitTypeId: 1
                  cardCreditDebitType: Credit
                  processCreditDebitTypeId: 1
                  processCreditDebitType: Credit
                  rrn: 10628361287F
                  cardTypeId: 0
                  cardType: null
                achProcessingDetails:
                  customerAccountNumber: null
                  customerRoutingNumber: null
                  accountHolderType: null
                  accountHolderTypeId: 0
                  accountType: null
                  accountTypeId: 0
                  taxId: null
                availableOperations:
                  - typeId: 3
                    type: Capture
                    availableAmount: 97.85
                    suggestedTips: null
                  - typeId: 4
                    type: Void
                    availableAmount: null
                    suggestedTips: null
                avsResponse:
                  actionId: 1
                  action: Allow
                  responseCode: '0'
                  groupId: 5
                  group: ValidGroup
                  resultId: 1
                  result: Passed
                  codeDescription: >-
                    The The street address and ZIP Code match the information on
                    file.
                emvTags:
                  ac: 533C2902770EA987
                  tvr: '0040040000'
                  tsi: null
                  aid: A0000000031010
                  applicationLabel: MasterCard
                  rawTags:
                    - key: 5F34
                      value: SOMETHING
                    - key: 5F35
                      value: SOMETHING
                orderNumber: '752314'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/transactions/auth:
    post:
      tags:
        - Transactions
      summary: Authorizes a transaction
      operationId: pay_api_v1_transactions_auth
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/auth</span>


        This endpoint authorizes a payment transaction.


        This verifies that the customer's payment method is valid and that
        sufficient funds or credit are available.


        <span class="api-seealso">See Also:</span><br>

        To capture or complete a transaction, see `POST
        {/pay-api/v1/transactions/capture`<br>

        To settle a transaction, see `POST /pay-api/v1/transactions/settle`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationRequest
            examples:
              Card not present Auth:
                value:
                  cardDataSource: 1
                  deviceid: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
                  paymentProcessorId: 37bd9ccb-2c9d-45cf-a65f-c9a224bdeaeb
                  customerId: null
                  paymentMethodId: d6e6a259-6e7f-4a8b-9c0d-1e2f3a4b5c81
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: 3
                  surchargeRate: 4
                  useCardPrice: null
                  appVersion: 10.413.01
                  sdkVersion: 8.61.01
                  billingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 21 E. Main Street
                    line2: Office 7
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  shippingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 21 E. Main Street
                    line2: null
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  contactInfo:
                    firstName: John
                    lastName: Smith
                    companyName: Flute
                    email: j.smith29f@example.com
                    mobileNumber: '+1415558787'
                    smsNotification: true
                  securityCode: '123'
                  expirationMonth: 12
                  expirationYear: 24
                  track1: null
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  pin: null
                  pinKsn: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Swipe Auth:
                value:
                  cardDataSource: 2
                  deviceid: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
                  paymentProcessorId: bb412700-f699-4e9d-922a-80c53a6c5c09
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: null
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  appVersion: 10.413.01
                  sdkVersion: 8.61.01
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: null
                  expirationYear: null
                  track1: '%B4111111111111111^Smith/John^12121010000000000000?'
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  pin: null
                  pinKsn: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              NFC Auth:
                value:
                  cardDataSource: 3
                  deviceid: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
                  paymentProcessorId: cf394859-95b3-4a89-a416-41e92bf6c1a7
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  appVersion: 10.413.01
                  sdkVersion: 8.61.01
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: null
                  expirationYear: null
                  track1: null
                  track2: 371449635392376=200257999
                  emvTags: null
                  emvPaymentAppVersion: null
                  pin: null
                  pinKsn: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              EMV auth:
                value:
                  cardDataSource: 4
                  deviceid: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
                  paymentProcessorId: f48dc06f-0a76-4eb6-b7d8-16c051a26f81
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  appVersion: 10.413.01
                  sdkVersion: 8.61.01
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: null
                  expirationYear: null
                  track1: null
                  track2: null
                  emvTags:
                    - 57114111111111111111D20122011334573581
                    - DF7809323832363938383433
                    - DF790C303030303030303030363230
                    - 9F2608533C2902770EA987
                    - 9F0206000000000100
                    - '95050040040000'
                    - 9F270180
                    - 9C0100
                    - 9A03150716
                    - 5F2A020840
                    - 9F3602001D
                    - '82020040'
                    - 9F37046C2F556A
                    - 5F340101
                    - 9F100706FF0A03A40000
                    - 9F3303E008C8
                    - 9F400101
                    - 4F07A0000000031010
                    - 9F0607A0000000041010
                    - 9F3403280000
                    - 9F120A4D617374657243617264
                    - 9F110101
                    - 500A56697361
                  emvPaymentAppVersion: null
                  pin: null
                  pinKsn: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              EMV contactless auth:
                value:
                  cardDataSource: 5
                  deviceid: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
                  paymentProcessorId: 078923fa-3019-412a-860c-bad612444003
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  appVersion: 10.413.01
                  sdkVersion: 8.61.01
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: null
                  expirationYear: null
                  track1: null
                  track2: null
                  emvTags:
                    - 57114111111111111111D20122011334573581
                    - DF7809323832363938383433
                    - DF790C303030303030303030363230
                    - 9F2608533C2902770EA987
                    - 9F0206000000000100
                    - '95050040040000'
                    - 9F270180
                    - 9C0100
                    - 9A03150716
                    - 5F2A020840
                    - 9F3602001D
                    - '82020040'
                    - 9F37046C2F556A
                    - 5F340101
                    - 9F100706FF0A03A40000
                    - 9F3303E008C8
                    - 9F400101
                    - 4F07A0000000031010
                    - 9F0607A0000000041010
                    - 9F3403280000
                    - 9F120A4D617374657243617264
                    - 9F110101
                    - 500A56697361
                  emvPaymentAppVersion: null
                  pin: null
                  pinKsn: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Fallback swipe Auth:
                value:
                  cardDataSource: 1
                  deviceid: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
                  paymentProcessorId: 45840b46-44a6-444f-a43e-6f3e62a29d21
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: null
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  appVersion: 10.413.01
                  sdkVersion: 8.61.01
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: null
                  expirationYear: null
                  track1: null
                  track2: 4111111111111111=200257999
                  emvTags: null
                  emvPaymentAppVersion: null
                  pin: null
                  pinKsn: null
                  emvFallbackCondition: 0
                  emvFallbackLastChipRead: 2
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Level 2-3 data:
                value:
                  cardDataSource: 1
                  deviceid: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
                  paymentProcessorId: e47c8e39-99ee-452e-baaf-f2d158d3fc54
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: 3
                  surchargeRate: 4
                  useCardPrice: null
                  appVersion: 10.413.01
                  sdkVersion: 8.61.01
                  billingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 21 E. Main Street
                    line2: null
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  shippingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 21 E. Main Street
                    line2: Office 7
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  contactInfo:
                    firstName: John
                    lastName: Smith
                    companyName: Flute
                    email: j.smith29f@example.com
                    mobileNumber: '+1415558787'
                    smsNotification: true
                  securityCode: '123'
                  expirationMonth: 12
                  expirationYear: 24
                  track1: null
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  pin: null
                  pinKsn: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2:
                    salesTaxRate: 20
                  l3:
                    invoiceNumber: invoice number
                    purchaseOrder: order
                    shippingCharges: 6
                    dutyCharges: 5
                    products:
                      - name: proguct-name
                        code: product-code
                        unitPrice: 3
                        measurementUnit: kg
                        quantity: 2
                        taxAmount: null
                        discountRate: 2
                        description: null
                        measurementUnitId: null
                  customerInitiatedTransaction: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationResponse
              examples:
                Authorization response:
                  description: >-
                    Transaction, type Authorization, status = Authorized.
                    Transaction status after an approved pre-authorization
                    request
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        Street Address and ZIP Code Match the information on
                        file.
                    transactionReceipt: null
                    transactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                    transactionDateTime: '2025-12-16T10:35:52.4081694Z'
                    typeId: 1
                    type: Authorization
                    statusId: 1
                    status: Authorized
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
                Partial authorization response:
                  description: >
                    Transaction, type Authorization, status =
                    PartiallyAuthorized.

                    Indicates that the issuer bank has approved only a portion
                    of the requested payment amount.
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        Street address and ZIP Code Match the information on
                        file.
                    transactionReceipt: null
                    transactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                    transactionDateTime: '2025-12-16T10:35:52.4081817Z'
                    typeId: 1
                    type: Authorization
                    statusId: 7
                    status: PartiallyAuthorized
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed.
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
                Sale response:
                  description: >
                    Transaction, type Sale, status = Captured. Transaction
                    status after approved sale or capture request.
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        Street address and ZIP Code Match the information on
                        file.
                    transactionReceipt: null
                    transactionId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                    transactionDateTime: '2025-12-16T10:35:52.4081829Z'
                    typeId: 2
                    type: Sale
                    statusId: 2
                    status: Captured
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed.
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/sale:
    post:
      tags:
        - Transactions
      summary: Creates a transaction
      operationId: pay_api_v1_transactions_sale
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/sale</span>


        This endpoint completes a transaction in a single step.


        It combines the two actions of authorizing and capturing a transaction
        into a single endpoint.

        Use this endpoint when the final amount is known and will not change.

        The transaction can be made immediately.


        <span class="api-seealso">See Also:</span><br>

        To authorize a transaction, see `POST /pay-api/v1/transactions/auth`<br>

        To capture or complete a transaction, see `POST
        {/pay-api/v1/transactions/capture`<br>

        To settle a transaction, see `POST /pay-api/v1/transactions/settle`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Sale.IsvSaleRequest
            examples:
              Card not present Sale:
                value:
                  cardDataSource: 1
                  deviceId: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
                  paymentProcessorId: 8d72c23b-5d52-42df-beee-1a96655e2be6
                  customerId: null
                  paymentMethodId: c5d59148-5d6e-4f7a-8b9c-0d1e2f3a4b70
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: 3
                  surchargeRate: 4
                  useCardPrice: null
                  billingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: null
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  shippingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: Office 7
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  contactInfo:
                    firstName: John
                    lastName: Smith
                    companyName: Flute
                    email: j.smith29f@example.com
                    mobileNumber: '+1415558787'
                    smsNotification: true
                  securityCode: '123'
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: null
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  pin: null
                  pinKsn: null
                  debit: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Swipe Sale:
                value:
                  paymentProcessorId: d2ae10f5-5085-4ae2-896f-590daf0392e8
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: '%B4111111111111111^Smith/John^12121010000000000000?'
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 2
                  pin: null
                  pinKsn: null
                  debit: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Nfc Sale:
                value:
                  paymentProcessorId: 426a0631-aa0c-400f-9204-4efb5e3c4691
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: null
                  track2: 371449635392376=200257999
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 3
                  pin: null
                  pinKsn: null
                  debit: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Emv Sale:
                value:
                  paymentProcessorId: f77dd5f0-f1b7-481b-b404-354eed3dd8bf
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: null
                  track2: null
                  emvTags:
                    - 57114111111111111111D20122011334573581
                    - DF7809323832363938383433
                    - DF790C303030303030303030363230
                    - 9F2608533C2902770EA987
                    - 9F0206000000000100
                    - '95050040040000'
                    - 9F270180
                    - 9C0100
                    - 9A03150716
                    - 5F2A020840
                    - 9F3602001D
                    - '82020040'
                    - 9F37046C2F556A
                    - 5F340101
                    - 9F100706FF0A03A40000
                    - 9F3303E008C8
                    - 9F400101
                    - 4F07A0000000031010
                    - 9F0607A0000000041010
                    - 9F3403280000
                    - 9F120A4D617374657243617264
                    - 9F110101
                    - 500A56697361
                  emvPaymentAppVersion: null
                  cardDataSource: 4
                  pin: null
                  pinKsn: null
                  debit: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Emv contactless Sale:
                value:
                  paymentProcessorId: 625466b6-8c9e-463d-bd82-d0f333fdaa9a
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: null
                  track2: null
                  emvTags:
                    - 57114111111111111111D20122011334573581
                    - DF7809323832363938383433
                    - DF790C303030303030303030363230
                    - 9F2608533C2902770EA987
                    - 9F0206000000000100
                    - '95050040040000'
                    - 9F270180
                    - 9C0100
                    - 9A03150716
                    - 5F2A020840
                    - 9F3602001D
                    - '82020040'
                    - 9F37046C2F556A
                    - 5F340101
                    - 9F100706FF0A03A40000
                    - 9F3303E008C8
                    - 9F400101
                    - 4F07A0000000031010
                    - 9F0607A0000000041010
                    - 9F3403280000
                    - 9F120A4D617374657243617264
                    - 9F110101
                    - 500A56697361
                  emvPaymentAppVersion: null
                  cardDataSource: 5
                  pin: null
                  pinKsn: null
                  debit: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Fallback swipe Sale:
                value:
                  paymentProcessorId: 066cd5c7-7c16-4d58-ade5-371bd46f0a31
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: null
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: null
                  surchargeRate: null
                  useCardPrice: null
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  securityCode: null
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: null
                  track2: 4111111111111111=200257999
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 6
                  pin: null
                  pinKsn: null
                  debit: null
                  emvFallbackCondition: 0
                  emvFallbackLastChipRead: 2
                  referenceId: null
                  l2: null
                  l3: null
                  customerInitiatedTransaction: false
              Level 2-3 data:
                value:
                  paymentProcessorId: ac972198-567c-4003-9f7a-32f66cefb7f4
                  customerId: null
                  paymentMethodId: e7f7b36a-7f8a-4b9c-0d1e-2f3a4b5c6d92
                  accountNumber: null
                  amount: 123.45
                  tipAmount: 1
                  tipRate: null
                  currencyId: 1
                  percentageOffRate: 3
                  surchargeRate: 4
                  useCardPrice: null
                  billingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: null
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  shippingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: Office 7
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  contactInfo:
                    firstName: John
                    lastName: Smith
                    companyName: Flute
                    email: j.smith29f@example.com
                    mobileNumber: '+1415558787'
                    smsNotification: true
                  securityCode: '123'
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: null
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 1
                  pin: null
                  pinKsn: null
                  debit: null
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: null
                  l2:
                    salesTaxRate: 20
                  l3:
                    invoiceNumber: invoice number
                    purchaseOrder: order
                    shippingCharges: 6
                    dutyCharges: 5
                    products:
                      - name: proguct-name
                        code: product-code
                        unitPrice: 3
                        measurementUnit: kg
                        quantity: 2
                        taxAmount: null
                        discountRate: 2
                        description: null
                        measurementUnitId: null
                  customerInitiatedTransaction: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationResponse
              examples:
                Authorization response:
                  description: >-
                    Transaction, type Authorization, status = Authorized.
                    Transaction status after an approved pre-authorization
                    request
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        The street address and ZIP Code match the information on
                        file.
                    transactionReceipt:
                      transactionId: a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36
                      transactionDateTime: '2026-12-16T10:35:52.000000Z'
                      amount:
                        baseAmount: 0
                        percentageOffAmount: 0
                        percentageOffRate: 0
                        cashDiscountAmount: 0
                        cashDiscountRate: 0
                        surchargeAmount: 0
                        surchargeRate: 0
                        tipAmount: 0
                        tipRate: 0
                        totalAmount: 0
                      currencyId: 1
                      currency: USD
                      processorId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                      processor: TSYS
                      operationTypeId: 0
                      operationType: null
                      paymentMethodTypeId: 0
                      paymentMethodType: null
                      transactionTypeId: 0
                      transactionType: null
                      customerId: null
                      customerPan: null
                      cardTokenType: 1
                      statusId: 0
                      status: null
                      merchantName: null
                      merchantAddress: null
                      merchantPhoneNumber: null
                      merchantEmailAddress: null
                      merchantWebsite: null
                      authCode: null
                      source: null
                      cardholderAuthenticationMethodId: null
                      cardholderAuthenticationMethod: null
                      cvmResultMsg: null
                      cardDataSourceId: null
                      cardDataSource: null
                      responseCode: null
                      responseDescription: null
                      cardProcessingDetails:
                        authCode: A0000
                        mid: null
                        tid: null
                        cardCreditDebitTypeId: 2
                        cardCreditDebitType: Debit
                        processCreditDebitTypeId: 1
                        processCreditDebitType: Credit
                        rrn: 10628361287F
                        cardTypeId: 0
                        cardType: null
                      achProcessingDetails:
                        customerAccountNumber: null
                        customerRoutingNumber: null
                        accountHolderType: null
                        accountHolderTypeId: 0
                        accountType: null
                        accountTypeId: 0
                        taxId: null
                      availableOperations:
                        - typeId: 4
                          type: Void
                          availableAmount: null
                          suggestedTips: null
                        - typeId: 8
                          type: TipAdjustment
                          availableAmount: null
                          suggestedTips:
                            - tipPercent: 5
                              tipAmount: 10
                            - tipPercent: 10
                              tipAmount: 20
                            - tipPercent: 15
                              tipAmount: 30
                      avsResponse:
                        actionId: 1
                        action: Allow
                        responseCode: null
                        groupId: 5
                        group: ValidGroup
                        resultId: 1
                        result: Passed
                        codeDescription: null
                      emvTags:
                        ac: 533C2902770EA987
                        tvr: '0040040000'
                        tsi: null
                        aid: A0000000031010
                        applicationLabel: MasterCard
                        rawTags:
                          - key: 5F34
                            value: SOMETHING
                          - key: 5F35
                            value: SOMETHING
                      orderNumber: '752314'
                    transactionId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                    transactionDateTime: '2025-12-16T10:35:52.4155781Z'
                    typeId: 1
                    type: Authorization
                    statusId: 1
                    status: Authorized
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
                Partial authorization response:
                  description: >-
                    Transaction, type Authorization, status =
                    PartiallyAuthorized. Indicates that the issuer bank has
                    approved only a portion of the requested payment amount.
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        The street address and ZIP Code match the information on
                        file.
                    transactionReceipt:
                      transactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                      transactionDateTime: '2026-12-16T10:35:52.000000Z'
                      amount:
                        baseAmount: 0
                        percentageOffAmount: 0
                        percentageOffRate: 0
                        cashDiscountAmount: 0
                        cashDiscountRate: 0
                        surchargeAmount: 0
                        surchargeRate: 0
                        tipAmount: 0
                        tipRate: 0
                        totalAmount: 0
                      currencyId: 1
                      currency: USD
                      processorId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                      processor: TSYS
                      operationTypeId: 0
                      operationType: null
                      paymentMethodTypeId: 0
                      paymentMethodType: null
                      transactionTypeId: 0
                      transactionType: null
                      customerId: null
                      customerPan: null
                      cardTokenType: 1
                      statusId: 0
                      status: null
                      merchantName: null
                      merchantAddress: null
                      merchantPhoneNumber: null
                      merchantEmailAddress: null
                      merchantWebsite: null
                      authCode: null
                      source: null
                      cardholderAuthenticationMethodId: null
                      cardholderAuthenticationMethod: null
                      cvmResultMsg: null
                      cardDataSourceId: null
                      cardDataSource: null
                      responseCode: null
                      responseDescription: null
                      cardProcessingDetails:
                        authCode: A0000
                        mid: null
                        tid: null
                        cardCreditDebitTypeId: 2
                        cardCreditDebitType: Debit
                        processCreditDebitTypeId: 1
                        processCreditDebitType: Credit
                        rrn: 10628361287F
                        cardTypeId: 0
                        cardType: null
                      achProcessingDetails:
                        customerAccountNumber: null
                        customerRoutingNumber: null
                        accountHolderType: null
                        accountHolderTypeId: 0
                        accountType: null
                        accountTypeId: 0
                        taxId: null
                      availableOperations:
                        - typeId: 4
                          type: Void
                          availableAmount: null
                          suggestedTips: null
                        - typeId: 8
                          type: TipAdjustment
                          availableAmount: null
                          suggestedTips:
                            - tipPercent: 5
                              tipAmount: 10
                            - tipPercent: 10
                              tipAmount: 20
                            - tipPercent: 15
                              tipAmount: 30
                      avsResponse:
                        actionId: 1
                        action: Allow
                        responseCode: null
                        groupId: 5
                        group: ValidGroup
                        resultId: 1
                        result: Passed
                        codeDescription: null
                      emvTags:
                        ac: 533C2902770EA987
                        tvr: '0040040000'
                        tsi: null
                        aid: A0000000031010
                        applicationLabel: MasterCard
                        rawTags:
                          - key: 5F34
                            value: SOMETHING
                          - key: 5F35
                            value: SOMETHING
                      orderNumber: '752314'
                    transactionId: a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36
                    transactionDateTime: '2025-12-16T10:35:52.4155813Z'
                    typeId: 1
                    type: Authorization
                    statusId: 7
                    status: PartiallyAuthorized
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
                Sale response:
                  description: >-
                    Transaction, type Sale, status = Captured. Transaction
                    status after approved sale or capture request
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        The street address and ZIP Code match the information on
                        file.
                    transactionReceipt:
                      transactionId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                      transactionDateTime: '2026-12-16T10:35:52.000000Z'
                      amount:
                        baseAmount: 0
                        percentageOffAmount: 0
                        percentageOffRate: 0
                        cashDiscountAmount: 0
                        cashDiscountRate: 0
                        surchargeAmount: 0
                        surchargeRate: 0
                        tipAmount: 0
                        tipRate: 0
                        totalAmount: 0
                      currencyId: 1
                      currency: USD
                      processorId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                      processor: TSYS
                      operationTypeId: 0
                      operationType: null
                      paymentMethodTypeId: 0
                      paymentMethodType: null
                      transactionTypeId: 0
                      transactionType: null
                      customerId: null
                      customerPan: null
                      cardTokenType: 1
                      statusId: 0
                      status: null
                      merchantName: null
                      merchantAddress: null
                      merchantPhoneNumber: null
                      merchantEmailAddress: null
                      merchantWebsite: null
                      authCode: null
                      source: null
                      cardholderAuthenticationMethodId: null
                      cardholderAuthenticationMethod: null
                      cvmResultMsg: null
                      cardDataSourceId: null
                      cardDataSource: null
                      responseCode: null
                      responseDescription: null
                      cardProcessingDetails:
                        authCode: A0000
                        mid: null
                        tid: null
                        cardCreditDebitTypeId: 2
                        cardCreditDebitType: Debit
                        processCreditDebitTypeId: 1
                        processCreditDebitType: Credit
                        rrn: 10628361287F
                        cardTypeId: 0
                        cardType: null
                      achProcessingDetails:
                        customerAccountNumber: null
                        customerRoutingNumber: null
                        accountHolderType: null
                        accountHolderTypeId: 0
                        accountType: null
                        accountTypeId: 0
                        taxId: null
                      availableOperations:
                        - typeId: 4
                          type: Void
                          availableAmount: null
                          suggestedTips: null
                        - typeId: 8
                          type: TipAdjustment
                          availableAmount: null
                          suggestedTips:
                            - tipPercent: 5
                              tipAmount: 10
                            - tipPercent: 10
                              tipAmount: 20
                            - tipPercent: 15
                              tipAmount: 30
                      avsResponse:
                        actionId: 1
                        action: Allow
                        responseCode: null
                        groupId: 5
                        group: ValidGroup
                        resultId: 1
                        result: Passed
                        codeDescription: null
                      emvTags:
                        ac: 533C2902770EA987
                        tvr: '0040040000'
                        tsi: null
                        aid: A0000000031010
                        applicationLabel: MasterCard
                        rawTags:
                          - key: 5F34
                            value: SOMETHING
                          - key: 5F35
                            value: SOMETHING
                      orderNumber: '752314'
                    transactionId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                    transactionDateTime: '2025-12-16T10:35:52.4185469Z'
                    typeId: 2
                    type: Sale
                    statusId: 2
                    status: Captured
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/transactions/capture:
    post:
      tags:
        - Transactions
      summary: Captures a transaction
      operationId: pay_api_v1_transactions_capture
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/capture</span>


        This endpoint captures a previously authorized transaction.


        The capture must reference an existing authorized transaction.

        It intends to convert the authorization hold into a completed charge
        that will be submitted for settlement.

        When a transaction is first authorized, the customer's bank places a
        temporary hold on the funds.

        Those funds are not transfer the money yet.

        A capture confirms that the merchant intends to collect those funds and
        finalizes the transaction.

        Once captured, the transaction cannot be voided.


        For example, a customer orders $100 at a restaurant.

        The charge is authorized but the funds are not paid yet.

        The customer is waiting to add a tip amount.

        After the tip is included and a new amount is agreed on, the transaction
        is captured.

        Now, the funds are released for payment.


        <span class="api-seealso">See Also:</span><br>

        To authorize a transaction, see `POST /pay-api/v1/transactions/auth`<br>

        To refund a settled transaction, see `POST
        /pay-api/v1/transactions/return`<br>

        To capture an amount for funds transfer, see `POST
        /pay-api/v1/transactions/capture`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Capture.IsvCaptureRequest
            example:
              amount: 123.45
              transactionId: 4b25e010-5a4a-4bd0-9961-0cff14bdb41b
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/return:
    post:
      tags:
        - Transactions
      summary: Reverses a transaction
      operationId: pay_api_v1_transactions_return
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/return</span>


        This endpoint refunds or returns funds from an original transaction
        identifier. 


        This creates a refund transaction that is linked to a specific previous
        transaction.


        <span class="api-seealso">See Also:</span><br>

        To refund without a transaction identifier, see `POST
        /pay-api/v1/transactions/return/no-reference`<br>

        To settle a transaction, see `POST /pay-api/v1/transactions/settle`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Return.IsvReturnRequest
            examples:
              Credit return with reference:
                description: Transaction Id is required
                value:
                  track1: null
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 1
                  pin: null
                  pinKsn: null
                  transactionId: debb3098-3ca0-4b8b-b28d-d3a1c3e50e66
                  amount: null
              Debit return with reference:
                description: >-
                  Debit transaction Id and track 1, track 2 or EMV tags are
                  required
                value:
                  track1: B5413330056003511^CUST IMP MC 351/^2512101000000000
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 2
                  pin: null
                  pinKsn: null
                  transactionId: 6ffca2bb-a462-4bdd-96ab-65a1baff9492
                  amount: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/return/no-reference:
    post:
      tags:
        - Transactions
      summary: Credits from a transaction without reference
      operationId: pay_api_v1_transactions_return_without_reference
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/return/no-reference</span>


        This endpoint refunds or returns funds without a reference.


        Without a reference means the customer does not have the link to the
        original transaction identifier.

        This creates a refund transaction that is not linked to a specific
        previous transaction.

        Instead of refunding a known transaction identifier, the system
        processes a standalone credit back to the cardholder's payment method.


        The endpoint requires the administrative API permission: Ecommerce
        Refund Without Reference.


        <span class="api-seealso">See Also:</span><br>

        To refund using a transaction identifier, see `POST
        /pay-api/v1/transactions/return`<br>

        To settle a transaction, see `POST /pay-api/v1/transactions/settle`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Return.ReturnWORefRequest
            examples:
              Card present credit return without reference:
                value:
                  paymentProcessorId: 64aa4643-2c62-45fa-9554-3a69833114e9
                  customerId: null
                  amount: 10.1
                  currencyId: 1
                  accountNumber: null
                  securityCode: null
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: B5413330056003511^CUST IMP MC 351/^2512101000000000
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 2
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  pin: '1111'
                  pinKsn: '2222222222'
                  debit: false
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: '123456'
              Card not present credit return without reference:
                value:
                  paymentProcessorId: b0f1f89f-4e73-4fa9-87fb-fad260b038d0
                  customerId: null
                  amount: 10.1
                  currencyId: 1
                  accountNumber: '5413591081013511'
                  securityCode: '123'
                  expirationMonth: 11
                  expirationYear: 2032
                  track1: null
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 1
                  billingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: Office 7
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  shippingAddress:
                    city: Phoenix
                    countryId: 1
                    line1: 7429 Desert Mirage Lane
                    line2: null
                    postalCode: '85099'
                    stateName: Arizona
                    stateId: 4
                  contactInfo:
                    firstName: Greg
                    lastName: Black
                    companyName: Peppared Street Cafe
                    email: pepparedstreetcafe@example.com
                    mobileNumber: '+1415558787'
                    smsNotification: true
                  pin: null
                  pinKsn: null
                  debit: false
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: '123456'
              Card present debit return without reference:
                value:
                  paymentProcessorId: 8fd4c360-70ae-41f5-b11a-497fe66b41de
                  customerId: null
                  amount: 10.1
                  currencyId: 1
                  accountNumber: null
                  securityCode: null
                  expirationMonth: 12
                  expirationYear: 2032
                  track1: B5413330056003511^CUST IMP MC 351/^2512101000000000
                  track2: null
                  emvTags: null
                  emvPaymentAppVersion: null
                  cardDataSource: 2
                  billingAddress: {}
                  shippingAddress: {}
                  contactInfo: null
                  pin: '1111'
                  pinKsn: '2222222222'
                  debit: true
                  emvFallbackCondition: null
                  emvFallbackLastChipRead: null
                  referenceId: '123456'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationResponse
              examples:
                Authorization response:
                  description: >-
                    Transaction, type Authorization, status = Authorized.
                    Transaction status after an approved pre-authorization
                    request
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        The street address and ZIP Code match the information on
                        file.
                    transactionReceipt:
                      transactionId: b8c9d0e1-f2a3-4b4c-5d6e-7f8a9b0c1d47
                      transactionDateTime: '2026-12-16T10:35:52.000000Z'
                      amount:
                        baseAmount: 0
                        percentageOffAmount: 0
                        percentageOffRate: 0
                        cashDiscountAmount: 0
                        cashDiscountRate: 0
                        surchargeAmount: 0
                        surchargeRate: 0
                        tipAmount: 0
                        tipRate: 0
                        totalAmount: 0
                      currencyId: 1
                      currency: USD
                      processorId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                      processor: TSYS
                      operationTypeId: 0
                      operationType: null
                      paymentMethodTypeId: 0
                      paymentMethodType: null
                      transactionTypeId: 0
                      transactionType: null
                      customerId: null
                      customerPan: null
                      cardTokenType: 1
                      statusId: 0
                      status: null
                      merchantName: null
                      merchantAddress: null
                      merchantPhoneNumber: null
                      merchantEmailAddress: null
                      merchantWebsite: null
                      authCode: null
                      source: null
                      cardholderAuthenticationMethodId: null
                      cardholderAuthenticationMethod: null
                      cvmResultMsg: null
                      cardDataSourceId: null
                      cardDataSource: null
                      responseCode: null
                      responseDescription: null
                      cardProcessingDetails:
                        authCode: A0000
                        mid: null
                        tid: null
                        cardCreditDebitTypeId: 2
                        cardCreditDebitType: Debit
                        processCreditDebitTypeId: 1
                        processCreditDebitType: Credit
                        rrn: 10628361287F
                        cardTypeId: 0
                        cardType: null
                      achProcessingDetails:
                        customerAccountNumber: null
                        customerRoutingNumber: null
                        accountHolderType: null
                        accountHolderTypeId: 0
                        accountType: null
                        accountTypeId: 0
                        taxId: null
                      availableOperations:
                        - typeId: 4
                          type: Void
                          availableAmount: null
                          suggestedTips: null
                        - typeId: 8
                          type: TipAdjustment
                          availableAmount: null
                          suggestedTips:
                            - tipPercent: 5
                              tipAmount: 10
                            - tipPercent: 10
                              tipAmount: 20
                            - tipPercent: 15
                              tipAmount: 30
                      avsResponse:
                        actionId: 1
                        action: Allow
                        responseCode: null
                        groupId: 5
                        group: ValidGroup
                        resultId: 1
                        result: Passed
                        codeDescription: null
                      emvTags:
                        ac: 533C2902770EA987
                        tvr: '0040040000'
                        tsi: null
                        aid: A0000000031010
                        applicationLabel: MasterCard
                        rawTags:
                          - key: 5F34
                            value: SOMETHING
                          - key: 5F35
                            value: SOMETHING
                      orderNumber: '752314'
                    transactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                    transactionDateTime: '2025-12-16T10:35:52.4617311Z'
                    typeId: 1
                    type: Authorization
                    statusId: 1
                    status: Authorized
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
                Partial authorization response:
                  description: >-
                    Transaction, type Authorization, status =
                    PartiallyAuthorized. Indicates that the issuer bank has
                    approved only a portion of the requested payment amount.
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        The street address and ZIP Code match the information on
                        file.
                    transactionReceipt:
                      transactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                      transactionDateTime: '2026-12-16T10:35:52.000000Z'
                      amount:
                        baseAmount: 0
                        percentageOffAmount: 0
                        percentageOffRate: 0
                        cashDiscountAmount: 0
                        cashDiscountRate: 0
                        surchargeAmount: 0
                        surchargeRate: 0
                        tipAmount: 0
                        tipRate: 0
                        totalAmount: 0
                      currencyId: 1
                      currency: USD
                      processorId: a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36
                      processor: TSYS
                      operationTypeId: 0
                      operationType: null
                      paymentMethodTypeId: 0
                      paymentMethodType: null
                      transactionTypeId: 0
                      transactionType: null
                      customerId: null
                      customerPan: null
                      cardTokenType: 1
                      statusId: 0
                      status: null
                      merchantName: null
                      merchantAddress: null
                      merchantPhoneNumber: null
                      merchantEmailAddress: null
                      merchantWebsite: null
                      authCode: null
                      source: null
                      cardholderAuthenticationMethodId: null
                      cardholderAuthenticationMethod: null
                      cvmResultMsg: null
                      cardDataSourceId: null
                      cardDataSource: null
                      responseCode: null
                      responseDescription: null
                      cardProcessingDetails:
                        authCode: A0000
                        mid: null
                        tid: null
                        cardCreditDebitTypeId: 2
                        cardCreditDebitType: Debit
                        processCreditDebitTypeId: 1
                        processCreditDebitType: Credit
                        rrn: 10628361287F
                        cardTypeId: 0
                        cardType: null
                      achProcessingDetails:
                        customerAccountNumber: null
                        customerRoutingNumber: null
                        accountHolderType: null
                        accountHolderTypeId: 0
                        accountType: null
                        accountTypeId: 0
                        taxId: null
                      availableOperations:
                        - typeId: 4
                          type: Void
                          availableAmount: null
                          suggestedTips: null
                        - typeId: 8
                          type: TipAdjustment
                          availableAmount: null
                          suggestedTips:
                            - tipPercent: 5
                              tipAmount: 10
                            - tipPercent: 10
                              tipAmount: 20
                            - tipPercent: 15
                              tipAmount: 30
                      avsResponse:
                        actionId: 1
                        action: Allow
                        responseCode: null
                        groupId: 5
                        group: ValidGroup
                        resultId: 1
                        result: Passed
                        codeDescription: null
                      emvTags:
                        ac: 533C2902770EA987
                        tvr: '0040040000'
                        tsi: null
                        aid: A0000000031010
                        applicationLabel: MasterCard
                        rawTags:
                          - key: 5F34
                            value: SOMETHING
                          - key: 5F35
                            value: SOMETHING
                      orderNumber: '752314'
                    transactionId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                    transactionDateTime: '2025-12-16T10:35:52.461734Z'
                    typeId: 1
                    type: Authorization
                    statusId: 7
                    status: PartiallyAuthorized
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
                Sale response:
                  description: >-
                    Transaction, type Sale, status = Captured. Transaction
                    status after approved sale or capture request
                  value:
                    processedAmount: 10
                    avsResponse:
                      actionId: 1
                      action: Allow
                      responseCode: '0'
                      groupId: 5
                      group: ValidGroup
                      resultId: 1
                      result: Passed
                      codeDescription: >-
                        The street address and ZIP Code match the information on
                        file.
                    transactionReceipt:
                      transactionId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                      transactionDateTime: '2026-12-16T10:35:52.000000Z'
                      amount:
                        baseAmount: 0
                        percentageOffAmount: 0
                        percentageOffRate: 0
                        cashDiscountAmount: 0
                        cashDiscountRate: 0
                        surchargeAmount: 0
                        surchargeRate: 0
                        tipAmount: 0
                        tipRate: 0
                        totalAmount: 0
                      currencyId: 1
                      currency: USD
                      processorId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                      processor: TSYS
                      operationTypeId: 0
                      operationType: null
                      paymentMethodTypeId: 0
                      paymentMethodType: null
                      transactionTypeId: 0
                      transactionType: null
                      customerId: null
                      customerPan: null
                      cardTokenType: 1
                      statusId: 0
                      status: null
                      merchantName: null
                      merchantAddress: null
                      merchantPhoneNumber: null
                      merchantEmailAddress: null
                      merchantWebsite: null
                      authCode: null
                      source: null
                      cardholderAuthenticationMethodId: null
                      cardholderAuthenticationMethod: null
                      cvmResultMsg: null
                      cardDataSourceId: null
                      cardDataSource: null
                      responseCode: null
                      responseDescription: null
                      cardProcessingDetails:
                        authCode: A0000
                        mid: null
                        tid: null
                        cardCreditDebitTypeId: 2
                        cardCreditDebitType: Debit
                        processCreditDebitTypeId: 1
                        processCreditDebitType: Credit
                        rrn: 10628361287F
                        cardTypeId: 0
                        cardType: null
                      achProcessingDetails:
                        customerAccountNumber: null
                        customerRoutingNumber: null
                        accountHolderType: null
                        accountHolderTypeId: 0
                        accountType: null
                        accountTypeId: 0
                        taxId: null
                      availableOperations:
                        - typeId: 4
                          type: Void
                          availableAmount: null
                          suggestedTips: null
                        - typeId: 8
                          type: TipAdjustment
                          availableAmount: null
                          suggestedTips:
                            - tipPercent: 5
                              tipAmount: 10
                            - tipPercent: 10
                              tipAmount: 20
                            - tipPercent: 15
                              tipAmount: 30
                      avsResponse:
                        actionId: 1
                        action: Allow
                        responseCode: null
                        groupId: 5
                        group: ValidGroup
                        resultId: 1
                        result: Passed
                        codeDescription: null
                      emvTags:
                        ac: 533C2902770EA987
                        tvr: '0040040000'
                        tsi: null
                        aid: A0000000031010
                        applicationLabel: MasterCard
                        rawTags:
                          - key: 5F34
                            value: SOMETHING
                          - key: 5F35
                            value: SOMETHING
                      orderNumber: '752314'
                    transactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                    transactionDateTime: '2025-12-16T10:35:52.4617457Z'
                    typeId: 2
                    type: Sale
                    statusId: 2
                    status: Captured
                    details:
                      hostResponseCode: '00'
                      hostResponseMessage: APPROVAL
                      hostResponseDefinition: Approved and completed
                      code: Approve
                      message: Success
                      processorResponseCode: null
                      authCode: VTLMC1
                      maskedPan: null
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-api/v1/transactions/settle:
    post:
      tags:
        - Transactions
      summary: Settles transactions
      operationId: pay_api_v1_transactions_settle
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/settle</span>


        This endpoint settles, or completes, a transaction.


        A settlement transaction is the step in the payment process when an
        authorized transaction is finalized.

        The funds are transferred to the merchant's acquiring bank.


        <span class="api-seealso">See Also:</span><br>

        To authorize a transaction, see `POST /pay-api/v1/transactions/auth`<br>

        To refund a settled transaction, see `POST
        /pay-api/v1/transactions/return`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Settle.IsvSettleRequest
            example:
              paymentProcessorId: b72b54b3-de02-430c-80c3-2908167d817c
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Settle.IsvSettleResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/void:
    post:
      tags:
        - Transactions
      summary: Voids a transaction
      operationId: pay_api_v1_transactions_void
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/void</span>


        This endpoint voids or cancels a transaction payment before it is
        processed or settled.


        The transaction cannot be voided after it has been captured.


        <span class="api-seealso">See Also:</span><br>

        To authorize a transaction, see `POST /pay-api/v1/transactions/auth`<br>

        To refund a settled transaction, see `POST
        /pay-api/v1/transactions/return`<br>

        To capture an amount for funds transfer, see `POST
        /pay-api/v1/transactions/capture`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Void.IsvVoidRequest
            example:
              transactionId: 881eabbc-6138-4677-9d37-592e7dca46f3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/tip-adjustment:
    post:
      tags:
        - Transactions
      summary: Adjusts for tips
      operationId: pay_api_v1_transactions_tip_adjustment
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/tip-adjustment</span>


        This endpoint adjusts the tip amount.


        This must be on a previously authorized transaction before settlement.

        Typically, the transaction is authorized first and for the base amount
        only.

        This endpoint adds an additional amount, the tip, above that base
        amount.

        The total amount from the original base amount is adjusted with the tip
        amount for settlement.


        <span class="api-seealso">See Also:</span><br>

        To authorize a transaction, see `POST /pay-api/v1/transactions/auth`
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.TipAdjustment.TipAdjustmentRequest
            example:
              transactionId: f7b48aea-0b3a-40a6-b005-c2d840f71ff7
              tipAmount: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/{id}/send-transaction-receipt-by-sms:
    post:
      tags:
        - Transactions
      summary: Sends a transaction receipt by SMS
      operationId: pay_api_v1_transactions_{id}_send_transaction_receipt_by_sms
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/{{transactionId}}/send-transaction-receipt-by-sms</span>


        This endpoint sends a transaction receipt to the customer by SMS.
      parameters:
        - name: transactionId
          in: path
          required: true
          description: |
            Specifies the transaction identifier.
          schema:
            type: string
            format: uuid
            example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.SendReceiptBySms.SendIsvTransactionReceiptBySmsRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.SendReceiptBySms.SendIsvTransactionReceiptBySmsRequest
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/calculate-amount:
    get:
      tags:
        - Transactions
      summary: Calculates transaction amounts
      operationId: pay_api_v1_transactions_calculate_amount
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/calculate-amount</span>


        This endpoint calculates transaction amounts.


        The amounts are based on the merchant's ZCP (zero cost processing) mode.

        This includes dual pricing, cash discounts, or credit card surcharges.

        Applications, such as payment terminals or point of service devices, can
        then display the appropriate amounts.


        The calculated amounts are for information only.

        Applications, such as payment terminals or point of service devices, can
        display the appropriate values.

        For example, clients could review the suggestions before submitting the
        payment.


        ZCP (zero cost processing) affects the parameter usage.<br>

        **ZCP = None**<br>

        Only `amount`, `percentageOffRate` (if the merchant has
        IsPercentageOffEnabled), and `tipAmount/tipRate` are applied.

        All other values are ignored, even if present.<br>

        **ZCP = CashDiscount**<br>

        The discount rate always comes from the merchant's
        DefaultCashDiscountRate.

        Applies only to cash and ACH transactions.

        All other values are ignored, even if present.<br>

        **ZCP = DualPricing**<br>

        The `useCardPrice` is required.

        The `surchargeRate` is ignored.
      parameters:
        - name: amount
          in: query
          description: >
            Specifies the base transaction amount (in USD) before discounts and
            fees.


            Example: 29.49
          schema:
            type: number
            format: double
            required: true
            multipleOf: 0.01
            example: 29.49
        - name: currencyId
          in: query
          description: |
            Specifies the the Flute currency code.

            It must be **1** (for USD).

            Example: 1
          schema:
            type: integer
            format: int32
            example: 1
            required: true
        - name: useCardPrice
          in: query
          description: |
            Specifies to calculate the transaction amount for card payment.

            If `true`, calculate transaction amount for card payment.<br>
            If `false`, calculate transaction amount for cash or an ACH payment.

            Example: true
          schema:
            type: boolean
            example: true
            default: true
        - name: percentageOffRate
          in: query
          description: |
            Specifies the percentage off or the discount rate.

            Example: 25 (for 25%)
          schema:
            type: number
            format: double
            minimum: 0
            maximum: 100
            default: 0
            example: 25
        - name: surchargeRate
          in: query
          description: >
            Specifies the credit card surcharge rate.


            Only applies when `useCardPrice` ia `true`.


            It may be omitted to use the default credit card surcharge rate
            setting in the merchant account.


            Example: 3.5 (for 3.5%)
          schema:
            type: number
            format: double
            minimum: 0
            maximum: 4
            example: 15
        - name: tipAmount
          in: query
          description: |
            Specifies the absolute amount (in USD) of the tip to be added.

            <span class="note">
            Values for `tipAmount` and `tipRate` are mutually exclusive.
            Care must be taken to include one or the other but not both.
            </span>
          schema:
            type: number
            format: double
            example: 62.38
        - name: tipRate
          in: query
          description: |
            Specifies the relative value of the tip to be added.

            <span class="note">
            Values for `tipAmount` and `tipRate` are mutually exclusive.
            Care must be taken to include one or the other but not both.
            </span>

            Example: 18 (for 18%)
          schema:
            type: number
            format: double
            example: 18
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Amounts.IsvAmountsResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /pay-api/v1/transactions/settings/autofill:
    get:
      tags:
        - Transaction Settings
      summary: Lists levels 2 and 3 autofill settings
      operationId: flute-v1-get-pay-api-transactions-settings-autofill
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/settings/autofill</span>


        This endpoint retrieves Level 2 and Level 3 autofill settings.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentGateway.Contracts.TransactionSettings.GetAutofillSettingsResponseDto
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
    put:
      tags:
        - Transaction Settings
      summary: Updates levels 2 and 3 settings
      operationId: flute-v1-put-pay-api-transactions-settings-autofill
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-api/v1/transactions/settings/autofill</span>


        This endpoint updates Level 2-Level 3 autofill settings.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.TransactionSettings.CreateAutofillSettingsRequest
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
  /sub-api/v1/subscriptions:
    get:
      tags:
        - Subscription
      summary: Lists merchant's subscriptions
      operationId: sub_api_v1_list_subscriptions
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/sub-api/v1/subscriptions</span>


        This endpoint returns a list of the merchant's subscriptions.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: search
          in: query
          description: >
            <br>Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.
          schema:
            type: string
            example: Peppared
        - name: customerIds
          in: query
          description: |
            <br>Specifies a single customer identifier.

            Multiple values are not supported.

            Example: 019d9cb4-c430-7b49-b232-a6a5d07c8371
          schema:
            type: array
            items:
              type: string
              format: uuid
              example: 019d9cb4-c430-7b49-b232-a6a5d07c8371
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SubscriptionsService.Contracts.InternalApi.Subscriptions.Get.GetSubscriptionResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
        - Subscription
      summary: Creates a subscription
      operationId: sub_api_v1_create_subscriptions
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/sub-api/v1/subscriptions</span>


        This endpoint creates a subscription.


        A subscription is a recurring payment.

        The client authorizes a transaction at regular intervals, such as
        weekly, monthly, or annually.


        Payments represent:

        * **Recurring billing**. The transaction happens automatically on a set
        schedule without the client having to re-enter payment details.

        * **Pre-authorization**. The customer approves transactions for future
        charges.

        * **Fixed or variable amounts**. The transaction can be the same every
        cycle, such as for a streaming service or vary based on usage, such as a
        utility bill)
      requestBody:
        description: Request parameters
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SubscriptionsService.Contracts.Subscriptions.Create.CreateSubscriptionRequestDto
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SubscriptionsService.Contracts.Subscriptions.Create.CreateSubscriptionResponseDto
              example:
                id: 5dd66afe-481a-4718-ad82-3d330a9735c6
                payNowSuccess: true
                transactionId: 798c3112-54c3-4ba9-b2aa-832d1f724024
                payNowResponse: null
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /sub-api/v1/subscriptions/{subscriptionId}:
    get:
      tags:
        - Subscription
      summary: Retrieves a subscription by ID
      operationId: flute-v1-get-sub-api-subscriptions-subscriptionId
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/sub-api/v1/subscriptions/{subscriptionId}</span>


        This endpoint retrieves a specified subscription.
      parameters:
        - name: subscriptionId
          in: path
          description: |
            <br>Specifies the subscription identifier.
          required: true
          schema:
            type: string
            format: uuid
            example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SubscriptionsService.Contracts.InternalApi.Subscriptions.Get.GetSubscriptionResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /sub-api/v1/subscriptions/{subscriptionId}/payments:
    get:
      tags:
        - Subscription
      summary: Retrieves a subscription payment history
      operationId: flute-v1-get-sub-api-subscriptions-subscriptionId-payments
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/sub-api/v1/subscriptions/{{subscriptionId}}/payments</span>


        This endpoint retrieves a history of payments for a specified
        subscription.
      parameters:
        - name: subscriptionId
          in: path
          description: |
            <br>Specifies the subscription identifier.
          required: true
          schema:
            type: string
            format: uuid
            example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - name: hideCompletedAndPlanned
          in: query
          description: >
            Specifies leaving out completed and planned payments from the
            history list.


            The retrieved payment history list could excluded previously
            completed and planned payments.


            If `true`, leaves out completed and planned payments.<br>

            If `false`, includes completed and planned payments.

            This includes in-progress, failed, pending, or actionable payments.


            Example: true
          example: true
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentsResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /sub-api/v1/subscriptions/{subscriptionId}/terminate:
    put:
      tags:
        - Subscription
      summary: Terminates a subscription
      operationId: flute-v1-put-sub-api-subscriptions-subscriptionId-terminate
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/sub-api/v1/subscriptions/{{subscriptionId}}/terminate</span>


        This endpoint terminates, or cancels, an active subscription.


        This action occurs immediately and cannot be undone.
      parameters:
        - name: subscriptionId
          in: path
          description: |
            <br>Specifies the subscription identifier.
          required: true
          schema:
            type: string
            format: uuid
            example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SubscriptionsService.Contracts.InternalApi.Subscriptions.Terminate.TerminateSubscriptionResponse
              example:
                id: 055422f6-93a0-4872-9134-76153da2a0b9
                statusId: 5
                status: Terminated
                message: >
                  Subscription is terminated.


                  Future payments will no longer be processed. This action is
                  permanent.
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pos-api/v1/pos-transactions:
    get:
      tags:
        - POS Transactions
      summary: Lists POS transactions
      operationId: flute-v1-get-pos-api-pos-transactions
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pos-api/v1/pos-transactions</span>
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: terminalId
          in: query
          description: |
            Specifies the terminal identifier.
          schema:
            type: string
            format: uuid
            example: 2428b5e7-6386-42ad-8b1c-d2a9032da4b3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Contracts.Page.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto
              example:
                items:
                  - id: 8b6c7c7e-6c62-4e7a-9e0c-3d3c1c4d9f9d
                    createdOn: '2025-12-15T10:35:52.5407322Z'
                    terminalId: c2a1a3c2-2d9e-4c0e-b0f4-6a7b5f1e2d11
                    posTransactionStatusId: 6
                    posTransactionStatus: Completed
                    transactionId: 1f7e3d2a-9c4b-4c7d-8b7e-2a3c4d5e6f70
                    amount: 10
                    currencyId: 1
                    targetTransactionId: null
                    transactionTypeId: 2
                    transactionType: Sale
                    isCompleted: true
                total: 100
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
        - POS Transactions
      summary: Creates a POS transaction
      operationId: flute-v1-post-pos-api-pos-transactions
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pos-api/v1/pos-transactions</span>


        Initiate a new transaction on the terminal device with predefined
        information, such as amount and transaction type.
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PosService.Contracts.PosTransactions.Create.CreatePosTransactionRequestDto
            example:
              posDeviceId: '000000001'
              referenceId: '10001'
              transactionTypeId: 2
              targetTransactionId: null
              amount: 10
              useCardPrice: null
              currencyId: 1
              paymentProcessorId: d9c3a8b1-6e2d-4f7c-a1b2-3c4d5e6f7a81
              terminalId: 3a7c9d1e-5b2f-4c8a-9d7e-1a2b3c4d5e92
              customerId: null
              waitForAcceptanceByTerminal: false
              readingMethodId: null
              requestPaymentMethodStorageConsent: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PosService.Contracts.PosTransactions.PosTransactionResponseDto
              examples:
                Create:
                  value:
                    posTransactionId: 6f1a2b3c-4d5e-4f6a-b7c8-9d0e1f2a3b03
                    statusId: 1
                    status: TerminalConnecting
                Cancel:
                  value:
                    posTransactionId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                    statusId: 4
                    status: CancelByPos
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pos-api/v1/pos-transactions/{id}:
    get:
      tags:
        - POS Transactions
      summary: Retrieves a POS transaction by ID
      operationId: flute-v1-get-pos-api-pos-transactions-id
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pos-api/v1/pos-transactions/{{posTransactionsid}}</span>


        Gets POS transaction by ID
      parameters:
        - name: posTransactionsid
          in: path
          description: |
            Indicates the POS transaction identifier.
          required: true
          schema:
            type: string
            format: uuid
            example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7
        - name: waitForTransactionProcessing
          in: query
          description: >
            <br>Specifies the transaction to wait for a transition to one of
            completed statuses or a timeout. 


            If `true`, transaction is to wait for a transition.<br>

            If `false`, transaction is not to wait for a transition.


            Example: true
          schema:
            type: boolean
            default: false
            example: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto
              example:
                id: a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36
                createdOn: '2025-12-15T10:35:52.5407322Z'
                modifiedOn: '2025-12-15T10:35:52.2318812Z'
                merchantId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                customerId: null
                terminalId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                paymentProcessorId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                posDeviceId: '000000001'
                referenceId: '10001'
                posTransactionStatusId: 6
                posTransactionStatus: Completed
                transactionId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                amount: 10
                currencyId: 1
                targetTransactionId: null
                transactionTypeId: 2
                transactionType: Sale
                isCompleted: true
                transaction:
                  transactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                  amount: 10
                  currencyId: 1
                  transactionStatusId: 2
                  transactionStatus: Captured
                  transactionTypeId: 2
                  transactionType: Sale
                  authCode: 0000A
                  mid: '43252511'
                  tid: '8820432549239101'
                transactionReceipt:
                  transactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                  transactionDateTime: '2025-12-16T10:35:52.4081694Z'
                  amount:
                    baseAmount: 0
                    percentageOffAmount: 0
                    percentageOffRate: 0
                    cashDiscountAmount: 0
                    cashDiscountRate: 0
                    surchargeAmount: 0
                    surchargeRate: 0
                    tipAmount: 0
                    tipRate: 0
                    totalAmount: 0
                  currencyId: 1
                  currency: USD
                  processorId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                  processor: TSYS
                  operationTypeId: 0
                  operationType: null
                  paymentMethodTypeId: 0
                  paymentMethodType: null
                  transactionTypeId: 0
                  transactionType: null
                  customerId: null
                  customerPan: null
                  cardTokenType: 1
                  statusId: 0
                  status: null
                  merchantName: null
                  merchantAddress: null
                  merchantPhoneNumber: null
                  merchantEmailAddress: null
                  merchantWebsite: null
                  authCode: null
                  source: null
                  cardholderAuthenticationMethodId: null
                  cardholderAuthenticationMethod: null
                  cvmResultMsg: null
                  cardDataSourceId: null
                  cardDataSource: null
                  responseCode: null
                  responseDescription: null
                  cardProcessingDetails:
                    authCode: A0000
                    mid: null
                    tid: null
                    cardCreditDebitTypeId: 2
                    cardCreditDebitType: Debit
                    processCreditDebitTypeId: 1
                    processCreditDebitType: Credit
                    rrn: 10628361287F
                    cardTypeId: 0
                    cardType: null
                  achProcessingDetails:
                    customerAccountNumber: null
                    customerRoutingNumber: null
                    accountHolderType: null
                    accountHolderTypeId: 0
                    accountType: null
                    accountTypeId: 0
                    taxId: null
                  availableOperations:
                    - typeId: 4
                      type: Void
                      availableAmount: null
                      suggestedTips: null
                    - typeId: 8
                      type: TipAdjustment
                      availableAmount: null
                      suggestedTips:
                        - tipPercent: 5
                          tipAmount: 10
                        - tipPercent: 10
                          tipAmount: 20
                        - tipPercent: 15
                          tipAmount: 30
                  avsResponse:
                    actionId: 1
                    action: Allow
                    responseCode: null
                    groupId: 5
                    group: ValidGroup
                    resultId: 1
                    result: Passed
                    codeDescription: null
                  emvTags:
                    ac: 533C2902770EA987
                    tvr: '0040040000'
                    tsi: null
                    aid: A0000000031010
                    applicationLabel: MasterCard
                    rawTags:
                      - key: 5F34
                        value: SOMETHING
                      - key: 5F35
                        value: SOMETHING
                  orderNumber: '752314'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
  /pos-api/v1/pos-transactions/{id}/cancel:
    post:
      tags:
        - POS Transactions
      summary: Cancels a POS transaction by ID
      operationId: flute-v1-post-pos-api-pos-transactions-id-cancel
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pos-api/v1/pos-transactions/{{posTransactionsid}}/cancel</span>


        This endpoint cancels a POS transaction by ID.
      parameters:
        - name: posTransactionsid
          in: path
          description: |
            Specifies the POS transaction identifier.
          required: true
          schema:
            type: string
            format: uuid
            example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7e03
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PosService.Contracts.PosTransactions.PosTransactionResponseDto
              examples:
                Create:
                  value:
                    posTransactionId: e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14
                    statusId: 1
                    status: TerminalConnecting
                Cancel:
                  value:
                    posTransactionId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                    statusId: 4
                    status: CancelByPos
  /pos-api/v1/pos-transactions/{posTransactionId}/print:
    post:
      tags:
        - POS Transactions
      summary: Prints a POS transaction receipt
      operationId: flute-v1-post-pos-api-pos-transactions-posTransactionId-print
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pos-api/v1/pos-transactions/{{posTransactionId}}/print</span>


        This endpoint allows semi-integrated ISVs to trigger a physical reprint
        of a

        completed transaction receipt directly from the POS terminal.


        It supports customer requests for duplicate receipts in-person, enabling
        a

        seamless merchant experience.
      parameters:
        - name: posTransactionId
          in: path
          description: |
            Indicates the POS transaction identifier.
          required: true
          schema:
            type: string
            format: uuid
            example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7
      requestBody:
        description: Print request payload must include required terminalId
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PosService.Contracts.PosTransactions.PrintTransactionReceipt.PrintTransactionReceiptRequestDto
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
  /pos-api/v1/terminals:
    get:
      tags:
        - Terminals
      summary: Lists merchant's terminals
      operationId: flute-v1-get-pos-api-terminals
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pos-api/v1/terminals</span>


        This endpoint lists a merchant's terminals.
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: search
          in: query
          schema:
            type: string
            example: Peppared
          description: >
            Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.
        - name: deliveryStatusId
          in: query
          schema:
            type: integer
            format: int32
        - name: serialNumber
          in: query
          schema:
            type: string
        - name: manufacturerIds
          in: query
          schema:
            type: array
            items:
              type: integer
              format: int32
        - name: modelIds
          in: query
          schema:
            type: array
            items:
              type: integer
              format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Contracts.Page.Contracts.Terminals.List.GetTerminalsResponseDto
              example:
                items:
                  - id: b4fd53c7-bcc0-4c5c-aab8-1024983f315b
                    merchantId: 8c2a42d1-9875-42e0-84a9-71f2fa5b4b9b
                    serialNumber: SN00000001
                    terminalManufacturer: SUNMI
                    terminalModel: Pro 1
                    deliveryStatusId: 3
                    deliveryStatusName: Active
                    createdOn: '2025-12-16T10:35:52.2487759Z'
                    modifiedOn: '2025-12-16T10:35:52.2487761Z'
                    merchantCompanyName: Merchant
                    terminalModeId: 1
                    terminalModeName: Standalone
                    connectionStatusId: 2
                    connectionStatus: Offline
                    lastSeenTimestamp: '2025-12-16T09:35:52.2487774Z'
                total: 3
  /pos-api/v1/terminals/{id}/status:
    get:
      tags:
        - Terminals
      summary: Retrieves a merchant's terminal POS status by ID
      operationId: flute-v1-get-pos-api-terminals-id-status
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pos-api/v1/terminals/{{terminalId}}/status</span>


        Retrieves the current status and details of a terminal device. 


        This endpoint provides the latest available information about a
        terminal,

        updated in near real-time. 


        Depending on the terminal's internet connectivity and operational
        status,

        the response may include limited terminal data.
      parameters:
        - name: terminalId
          in: path
          description: TerminalId
          required: true
          schema:
            type: string
            format: uuid
            example: cbd59148-9f0a-4b1c-2d3e-4f5a6b7c8d14
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PosService.Contracts.Terminals.Status.Retrieve.RetrieveTerminalStatusResponseDto
              example:
                terminalPosStatusId: 1
                terminalPosStatus: Active
                terminalId: f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25
                timestamp: '0001-01-01T00:00:00'
                connectionStatusId: 1
                connectionStatus: '0'
                connectionTypeId: null
                connectionType: null
                wifiConnectionStrength: 0
                mobileConnectionStrength: 0
                lastSeenTimestamp: null
                debitPinKeyId: null
                debitPinKey: null
                availabilityStatusId: null
                availabilityStatus: null
                ariseTerminalVersion: null
                batteryLevel: 0
                printerStatusId: null
                printerStatus: null
                deviceSoftwareDetails: null
  /pay-int-api/categories:
    get:
      tags:
        - Categories
      summary: Retrieves a list of categories
      operationId: flute-v1-get-pay-int-api-categories
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/categories</span>


        This endpoint retrieves a list of category names.
      parameters:
        - name: search
          in: query
          description: >
            Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.
          schema:
            type: string
            example: Pappared
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Get.GetIsvCategoriesPageResponse
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
        - Categories
      summary: Creates a new category
      operationId: flute-v1-post-pay-int-api-categories
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/categories</span>


        This endpoint creates a new category.


        Category name must be unique in the merchant account.
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The category creation request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Create.CreateIsvCategoryRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.Categories.Create.CreateCategoryResponseDto
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-int-api/categories/{categoryId}:
    put:
      tags:
        - Categories
      summary: Updates a category by its ID
      operationId: flute-v1-put-pay-int-api-categories-categoryId
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/categories/{{categoryId}}</span>


        This endpoint updates or edits category information.


        The category name must be unique in the merchant account.
      parameters:
        - name: categoryId
          in: path
          description: |
            Specifies the identifier of the category to update.
          required: true
          schema:
            type: string
            format: uuid
            example: 7891b7c8-9d0e-4f1a-2b3c-4d5e6f7a8b14
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The category update request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Update.UpdateCategoryRequest
      responses:
        '200':
          description: Category updated successfully
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    delete:
      tags:
        - Categories
      summary: Deletes a category by its ID
      operationId: flute-v1-delete-pay-int-api-categories-categoryId
      description: >
        <span class="api-endpoint">DELETE {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/categories/{{categoryId}}</span>


        This endpoint deletes a category.


        This category will not be available in the catalog.

        Items linked to this category will still be in the catalog with empty
        category.
      parameters:
        - name: categoryId
          in: path
          required: true
          description: |
            Specifies the identifier of the category to delete.
          schema:
            type: string
            format: uuid
            example: 6780a6b7-8c9d-4e0f-1a2b-3c4d5e6f7a03
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '204':
          description: Category deleted successfully.
        '500':
          $ref: '#/components/responses/500'
  /pay-int-api/invoices:
    get:
      tags:
        - Invoices
      summary: Lists a collection of invoices
      operationId: flute-v1-get-pay-int-api-invoices
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices</span>


        This endpoint returns a list of invoices for the current merchant.


        The query parameters are filters used to more precisely return selected
        invoices.

        If no filters are specified, all invoices are returns.

        The search uses inclusive matching.

        That is, all specified filters must match to return an invoice.
      parameters:
        - name: issueDateFrom
          in: query
          description: >
            Specifies the start date-time (in an ISO 8601 date-time UTC format)
            the invoice was issued.


            The fields `issueDateFrom` and `issueDateTo` can be used together to
            form an inclusive date-time range.


            Examples:<br>

            2026-02<br>

            2026-02-19<br>

            2026-02-19T20:24:52.934Z
          schema:
            type: string
            format: date-time
            example: '2026-02-19T20:24:52.934Z'
        - name: issueDateTo
          in: query
          description: >
            Specifies the end date-time (in an ISO 8601 date-time UTC format)
            the invoice was issued.


            The fields `issueDateFrom` and `issueDateTo` can be used together to
            form an inclusive date-time range.


            Examples:<br>

            2026-02<br>

            2026-02-21<br>

            2026-02-21T20:24:52.934Z
          schema:
            type: string
            format: date-time
            example: '2026-03-19T20:24:52.934Z'
        - name: dueDateFrom
          in: query
          description: >
            Specifies the start date-time (in an ISO 8601 date-time UTC format)
            the invoice is due.


            The fields `dueDateFrom` and `dueDateTo` can be used together to
            form an inclusive date-time range.


            Examples:<br>

            2026-02<br>

            2026-02-19<br>

            2026-02-19T20:24:52.934Z
          schema:
            type: string
            format: date-time
            example: '2026-03-19T20:24:52.934Z'
        - name: dueDateTo
          in: query
          description: >
            Specifies the end date-time (in an ISO 8601 date-time UTC format)
            the invoice is due.


            The fields `dueDateFrom` and `dueDateTo` can be used together to
            form an inclusive date-time range.


            Examples:<br>

            2026-02<br>

            2026-02-21<br>

            2026-02-21T20:24:52.934Z
          schema:
            type: string
            format: date-time
            example: '2026-02-21T20:24:52.934Z'
        - name: paymentDateFrom
          in: query
          description: >
            Specifies the start date-time (in an ISO 8601 date-time UTC format)
            the invoice was paid.


            The fields `paymentDateFrom` and `paymentDateTo` can be used
            together to form an inclusive date-time range.


            Examples:<br>

            2026-02<br>

            2026-02-19<br>

            2026-02-19T20:24:52.934Z
          schema:
            type: string
            format: date-time
            example: '2026-03-19T20:24:52.934Z'
        - name: paymentDateTo
          in: query
          description: >
            Specifies the end date-time (in an ISO 8601 date-time UTC format)
            the payment was paid.


            The fields `paymentDateFrom` and `paymentDateTo` can be used
            together to form an inclusive date-time range.


            Examples:<br>

            2026-02<br>

            2026-02-21<br>

            2026-02-21T20:24:52.934Z
          schema:
            type: string
            format: date-time
            example: '2026-02-21T20:24:52.934Z'
        - name: status
          in: query
          description: |
            Specifies the status of the invoice.

            Possible values:

            | Value | Name              |
            |:-----:|-------------------|
            | 1     | Draft             |
            | 2     | Published         |
            | 3     | Paid              |
            | 4     | Expired           |
            | 5     | Canceled          |
            | 6     | ProcessingPayment |
            | 7     | Refunded          |

            Example: 2
          example: 2
          schema:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Enums.InvoiceStatus
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/asc'
        - name: search
          in: query
          description: >
            Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.
          schema:
            type: string
            example: Peppared
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Get.GetIsvInvoicesPageResponse
    post:
      tags:
        - Invoices
      summary: Creates an invoice
      operationId: flute-v1-post-pay-int-api-invoices
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices</span>


        This endpoint creates an invoice.
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: Specifies an invoice creation request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Create.CreateIsvInvoiceRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.Invoices.Create.CreateInvoiceResponseDto
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-int-api/invoices/{invoiceId}:
    get:
      tags:
        - Invoices
      summary: Retrieves an invoice's details
      operationId: flute-v1-get-pay-int-api-invoices-invoiceId
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}</span>
      parameters:
        - name: invoiceId
          in: path
          description: The identifier of the invoice to retrieve.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Get.GetIsvInvoiceResponse
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
    put:
      tags:
        - Invoices
      summary: Updates a specific invoice
      operationId: flute-v1-put-pay-int-api-invoices-invoiceId
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}</span>


        This endpoint updates a specified invoice.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>
      parameters:
        - name: invoiceId
          in: path
          description: The identifier of the invoice to update.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The invoice update request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Update.UpdateIsvInvoiceRequest
      responses:
        '200':
          description: Invoice updated successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
    delete:
      tags:
        - Invoices
      summary: Deletes an invoice
      operationId: flute-v1-delete-pay-int-api-invoices-invoiceId
      description: >
        <span class="api-endpoint">DELETE {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}</span>


        Published invoices cannot be deleted.
      parameters:
        - name: invoiceId
          in: path
          description: Specifies the identifier of the invoice to delete.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Invoice deleted successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
  /pay-int-api/invoices/{id}/submit:
    post:
      tags:
        - Invoices
      summary: Submits an invoice for processing
      operationId: flute-v1-post-pay-int-api-invoices-invoiceId-submit
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}/submit</span>
      parameters:
        - name: invoiceId
          in: path
          description: The identifier of the invoice to submit.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The request containing the details for invoice submission.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
  /pay-int-api/invoices/{invoiceId}/ach/submit:
    post:
      tags:
        - Invoices
      summary: Submits an ACH invoice for processing
      operationId: flute-v1-post-pay-int-api-invoices-invoiceId-ach-submit
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}/ach/submit</span>
      parameters:
        - name: invoiceId
          in: path
          description: The identifier of the invoice to submit.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The request containing the details for invoice submission.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SubmitAch.SubmitIsvAchInvoiceRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-int-api/invoices/{invoiceId}/calculations:
    get:
      tags:
        - Invoices
      summary: Retrieves calculations for an invoice
      operationId: flute-v1-get-pay-int-api-invoices-invoiceId-calculations
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}/calculations</span>


        This endpoint retrieves calculations for an invoice.
      parameters:
        - name: invoiceId
          in: path
          description: The identifier of the invoice.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Calculations.GetIsvInvoiceCalculationsResponse
  /pay-int-api/invoices/publish:
    post:
      tags:
        - Invoices
      summary: Publishes an invoice
      operationId: flute-v1-post-pay-int-api-invoices-publish
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/publish</span>
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The request containing the details for publishing the invoice.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Publish.PublishIsvInvoiceRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Publish.PublishIsvInvoiceResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-int-api/invoices/{invoiceId}/cancel:
    put:
      tags:
        - Invoices
      summary: Cancels an invoice
      operationId: flute-v1-put-pay-int-api-invoices-invoiceId-cancel
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}/cancel</span>


        This endpoint cancels an invoice.


        Only invoices in published(Due, Past Due) status and not paid can be
        canceled.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>
      parameters:
        - name: invoiceId
          in: path
          description: The identifier of the invoice to cancel.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Invoice cancelled successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
  /pay-int-api/invoices/{invoiceId}/mark-as-paid:
    put:
      tags:
        - Invoices
      summary: Marks an invoice as paid
      operationId: flute-v1-put-pay-int-api-invoices-invoiceId-mark-as-paid
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}/mark-as-paid</span>


        This endpoint marks an invoice as paid.


        Only invoices in published(Due, Past Due) status and not paid can be
        marked as paid.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>
      parameters:
        - name: invoiceId
          in: path
          description: The identifier of the invoice to mark as paid.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The request containing the payment details.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Update.UpdateIsvInvoiceStatusRequest
      responses:
        '200':
          description: Invoice marked as paid successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
  /pay-int-api/invoices/{invoiceId}/send-published-sms-notification:
    post:
      tags:
        - Invoices
      summary: Sends an invoice notification by SMS
      operationId: >-
        flute-v1-post-pay-int-api-invoices-invoiceId-send-published-sms-notification
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}/send-published-sms-notification</span>


        This endpoint sends an invoice notification by SMS.
      parameters:
        - name: invoiceId
          in: path
          description: >
            Specifies the identifier of the invoice for which to send the
            notification.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: |
          The request containing the details for the SMS notification.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SendInvoicePublishedSmsNotification.SendIsvInvoicePublishedSmsNotificationRequest
      responses:
        '200':
          description: SMS notification sent successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
  /pay-int-api/invoices/{invoiceId}/send-email-notification:
    post:
      tags:
        - Invoices
      summary: Sends an invoice notification by email
      operationId: flute-v1-post-pay-int-api-invoices-invoiceId-send-email-notification
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}/send-email-notification</span>


        This endpoint sends an invoice notification by email.
      parameters:
        - name: invoiceId
          in: path
          description: >
            Specifies the identifier of the invoice for which to send the
            notification.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: |
          The request containing the details for the Email notification.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SendInvoiceEmailNotification.SendInvoiceEmailNotificationRequest
      responses:
        '200':
          description: Email notification sent successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-int-api/invoices/{invoiceId}/download-pdf:
    get:
      tags:
        - Invoices
      summary: Downloads an invoice
      operationId: flute-v1-get-pay-int-api-invoices-invoiceId-download-pdf
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/invoices/{{invoiceId}}/download-pdf</span>


        This endpoint downloads the specified invoice as a PDF document.


        Available only for published invoices.
      parameters:
        - name: invoiceId
          in: path
          description: The identifier of the invoice.
          required: true
          schema:
            type: string
            format: uuid
            example: 9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f69
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
  /pay-int-api/merchants/{merchantId}/invoices/settings:
    get:
      tags:
        - Invoices Settings
      summary: Retrieves a merchant's invoice settings by ID
      operationId: flute-v1-get-pay-int-api-merchants-merchantId-invoices-settings
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/merchants/{{merchantId}}/invoices/settings</span>
      parameters:
        - name: merchantId
          in: path
          required: true
          description: |
            Specifies the identifier of the merchant.
          schema:
            type: string
            format: uuid
            example: 46063d32-10fa-44cb-b118-20ddd085ce3f
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.InvoiceSettings.Get.GetIsvInvoiceSettingsResponse
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ForbiddenExceptionExample
              example:
                details: >-
                  Forbidden to access Id 'f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25'
                  with type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 403
                source: <Service>
                exceptionType: Exceptions.ForbiddenException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
    put:
      tags:
        - Invoices Settings
      summary: Updates an invoice setting
      operationId: flute-v1-put-pay-int-api-merchants-merchantId-invoices-settings
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/merchants/{{merchantId}}/invoices/settings</span>


        This endpoint updates the specified invoice setting.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>
      parameters:
        - name: merchantId
          in: path
          required: true
          description: |
            Specifies the identifier of the merchant.
          schema:
            type: string
            format: uuid
            example: 46063d32-10fa-44cb-b118-20ddd085ce3f
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The invoice settings update request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.InvoiceSettings.Update.UpdateIsvInvoiceSettingsRequest
      responses:
        '200':
          description: Invoice settings updated successfully
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ForbiddenExceptionExample
              example:
                details: >-
                  Forbidden to access Id 'f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25'
                  with type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 403
                source: <Service>
                exceptionType: Exceptions.ForbiddenException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
  /pay-int-api/line-items:
    post:
      tags:
        - Line Items
      summary: Creates a line item
      operationId: flute-v1-post-pay-int-api-line-items
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/line-items</span>
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The line item creation request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Create.CreateIsvLineItemRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Create.CreateIsvLineItemResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: 13c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
    get:
      tags:
        - Line Items
      summary: Lists line items
      operationId: flute-v1-get-pay-int-api-line-items
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/line-items</span>
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: search
          in: query
          schema:
            type: string
            example: Peppared
          description: >
            Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.
        - name: categoryId
          in: query
          schema:
            type: string
            format: uuid
        - name: noCategory
          in: query
          schema:
            type: boolean
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Get.GetIsvLineItemsPageResponse
  /pay-int-api/line-items/{lineItemId}:
    put:
      tags:
        - Line Items
      summary: Updates a line item
      operationId: flute-v1-put-pay-int-api-line-items-lineItemId
      description: >
        <span class="api-endpoint">PUT {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/line-items/{{lineItemId}}</span>


        This endpoint updates the specified line item.


        <span style="background-color:#e0e0e0; padding:8px 8px;
        border-radius:4px;">

        Care must be taken to complete all the fields with the existing
        information.

        </span>
      parameters:
        - name: lineItemId
          in: path
          description: The ID of the line item to update.
          required: true
          schema:
            type: string
            format: uuid
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The line item update request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Update.UpdateIsvLineItemRequest
      responses:
        '200':
          description: Line item updated successfully
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
    delete:
      tags:
        - Line Items
      summary: Deletes a line item
      operationId: flute-v1-delete-pay-int-api-line-items-lineItemId
      description: >
        <span class="api-endpoint">DELETE {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/line-items/{{lineItemId}}</span>
      parameters:
        - name: lineItemId
          in: path
          description: The ID of the line item to delete.
          required: true
          schema:
            type: string
            format: uuid
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Line item was deleted successfully
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-int-api/line-items/unit-types:
    get:
      tags:
        - Line Items
      summary: Retrieves the available unit types for line items
      operationId: flute-v1-get-pay-int-api-line-items-unit-types
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/line-items/unit-types</span>
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Get.GetIsvLineItemUnitTypesResponse
  /pay-int-api/payment-sessions:
    post:
      tags:
        - Payment Sessions
      summary: Creates a new payment session
      operationId: pay_int_api_payment_sessions
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/payment-sessions</span>


        This endpoint creates a payment session object.


        The client, typically a frontend or checkout page, can use to securely
        collect payment details and process a transaction.


        For Flute Checkout, use of this endpoint is required.

        To use Flute Checkout, see [xxx](xxx) for details.


        For all other instances, use of this endpoint is not required.

        However, we encourage using it.

        Using a payment session:

        * protects payments from duplicating charges

        * manages complex flows, such as those with tips, surcharges, discounts,
        and authorization steps

        * offers fraud protection
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: Payment session creation request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentSessionRequestDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentSessionResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
              example:
                errors:
                  Email:
                    - '''Email'' is not a valid email address.'
                details: |-
                  Validation failed: 
                   -- Email: 'Email' is not a valid email address. Severity: Error
                statusCode: 400
                source: <Service>
                exceptionType: FluentValidation.ValidationException
                correlationId: f2a3b4c5-d6e7-4f8a-9b0c-1d2e3f4a5b81
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-int-api/payment-sessions/{paymentSessionId}/cancel:
    post:
      tags:
        - Payment Sessions
      summary: Cancels a payment session
      operationId: flute-v1-post-pay-int-api-payment-sessions-paymentSessionId-cancel
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/payment-sessions/{{paymentSessionId}}/cancel</span>
      parameters:
        - name: paymentSessionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: bac48037-8e9f-4a0b-1c2d-3e4f5a6b7c03
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Payment session cancelled successfully
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
              example:
                details: >-
                  Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with
                  type='<Service>.DataAccess.Entities.<Model>Entity'
                statusCode: 404
                source: <Service>
                exceptionType: Exceptions.NotFoundException
                correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
                entityId: null
                errorCode: null
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AspNet.Swagger.Examples.InternalExceptionExample
              example:
                details: null
                statusCode: 500
                source: <Service>
                exceptionType: Exceptions.IntegrationException
                correlationId: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a70
                entityId: null
                errorCode: null
  /pay-int-api/payment-sessions/{paymentSessionId}:
    get:
      tags:
        - Payment Sessions
      summary: Retrieves payment session details by ID
      operationId: pay_int_api_payment_sessions_{paymentSessionId}
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/payment-sessions/{{paymentSessionId}}</span>


        This endpoint retrieves the details of the specified payment session.
      parameters:
        - name: paymentSessionId
          in: path
          required: true
          description: >
            Specifies the identifier of the payment session to get the status
            and details.
          schema:
            type: string
            format: uuid
            example: fffa1259-272a-4bf3-a197-a5757c26eccb
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionIsvResponse
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
  /pay-int-api/ping:
    get:
      tags:
        - Ping
      summary: Pings an endpoint for health status
      operationId: flute-v1-get-pay-int-api-ping
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/ping</span>


        This endpoint ping endpoint to validate the token is active and valid.
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain; x-api-version=1.0:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.WebApi.Isv.Controllers.PingController.PingResponse
            application/json; x-api-version=1.0:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.WebApi.Isv.Controllers.PingController.PingResponse
            text/json; x-api-version=1.0:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.WebApi.Isv.Controllers.PingController.PingResponse
  /pay-int-api/quick-payments/one-time:
    post:
      tags:
        - Quick Payments
      summary: Creates a one-time payment link
      operationId: flute-v1-post-pay-int-api-quick-payments-one-time
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/one-time</span>


        This endpoint creates link for a one-time payment.


        A one-time is one that can be used only once and then it expires. 

        This can be used for cases like purchases or fee payments. 

        It is limited to only one person. 

        A one-time is in contrast to a reusable payment payment that can be use
        multiple times by different people.


        The link must be activated before use as a security feature.

        To activate a one-time payment link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/activate`


        The link remains active until one of the following occurs:

        * The customer completes the payment

        * The link is manually deactivated

        * The link's time limit expires


        <span class="api-seealso">See Also:</span><br>

        To activate a link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/activate`<br>

        To send a one-time payment link to a customer, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification`<br>

        To deactivate a link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`<br>

        To get a list of all one-time payments links, see `GET
        /pay-int-api/quick-payments/one-time`<br>

        To get details for a specified one-time payments link, see `POST
        /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The one-time payment link creation request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentResponse
    get:
      tags:
        - Quick Payments
      summary: Lists one-time links
      operationId: flute-v1-get-pay-int-api-quick-payments-one-time
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/one-time</span>


        This endpoint lists one-time payment links.


        The links may be valid or expired.


        The request may be filtered to limit returns to the specified search.


        <span class="api-seealso">See Also:</span><br>

        To create a one-time payment and link, see `POST
        /pay-int-api/quick-payments/one-time`<br>

        To see the details of a specified one-time payment, see `POST
        /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: search
          in: query
          description: >
            Specifies the search string.


            This performs a case insensitive, matching, or partially matching
            search.


            Fields does not have to be specified.

            If the results are to be sorted, the field `orderby` to specify the
            sort field.e
          schema:
            type: string
            example: Peppared
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.GetPage.GetIsvOneTimeQuickPaymentPageResponse
  /pay-int-api/quick-payments/one-time/{quickPaymentId}:
    get:
      tags:
        - Quick Payments
      summary: Retrieves details of a one-time link
      operationId: flute-v1-get-pay-int-api-quick-payments-one-time-quickPaymentId
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/one-time/{{quickPaymentId}}</span>


        This endpoint Retrieves details of a one-time payment.


        The link may be valid or expired.


        <span class="api-seealso">See Also:</span><br>

        To create a one-time payment and link, see `POST
        /pay-int-api/quick-payments/one-time`<br>

        To see a list of one-time payments, see `GET
        /pay-int-api/quick-payments/one-time`
      parameters:
        - $ref: '#/components/parameters/quickpaymentid'
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Get.GetIsvOneTimeQuickPaymentResponse
  /pay-int-api/quick-payments/{quickPaymentId}/activate:
    post:
      tags:
        - Quick Payments
      summary: Activates a payment link
      operationId: flute-v1-post-pay-int-api-quick-payments-quickPaymentId-activate
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/{{quickPaymentId}}/activate</span>


        This endpoint manually activates a one-time payment link.


        A created one-time payment link must be activated before using it.


        <span class="api-seealso">See Also:</span><br>

        To create a one-time payment link, see `POST
        /pay-int-api/quick-payments/one-time`<br>

        To send a one-time payment link to a customer, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification`<br>

        To manually deactivate a link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`<br>

        To get a list of all one-time payments links, see `GET
        /pay-int-api/quick-payments/one-time`<br>

        To get details for a specified one-time payments link, see `POST
        /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`
      parameters:
        - $ref: '#/components/parameters/quickpaymentid'
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
  /pay-int-api/quick-payments/{quickPaymentId}/deactivate:
    post:
      tags:
        - Quick Payments
      summary: Deactivates a payment link
      operationId: flute-v1-post-pay-int-api-quick-payments-quickPaymentId-deactivate
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/{{quickPaymentId}}/deactivate</span>


        This endpoint manually deactivates a one-time payment link.

        The link can also be manually deactivated any time after it is created
        but before the Customer completes payment.


        The link can be deactivated and cannot be used in the following
        situations:

        * The payment is made

        * The link is manually deactivated

        * The link's time limit expires


        <span class="api-seealso">See Also:</span><br>

        To create a one-time payment link, see `POST
        /pay-int-api/quick-payments/one-time`<br>

        To manually activate a link, see `POST POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/activate`<br>

        To send a one-time payment link to a customer, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification`<br>

        To get a list of all one-time payments links, see `GET
        /pay-int-api/quick-payments/one-time`<br>

        To get details for a specified one-time payments link, see `POST
        /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`
      parameters:
        - name: quickPaymentId
          $ref: '#/components/parameters/quickpaymentid'
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
  /pay-int-api/quick-payments/{quickPaymentId}/send-sms-notification:
    post:
      tags:
        - Quick Payments
      summary: Sends a link by SMS
      operationId: >-
        flute-v1-post-pay-int-api-quick-payments-quickPaymentId-send-sms-notification
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/{{quickPaymentId}}/send-sms-notification</span>


        This endpoint sends a one-time payment link to a customer through SMS.


        <span class="api-seealso">See Also:</span><br>

        To create a one-time payment link, see `POST
        /pay-int-api/quick-payments/one-time`<br>

        To activate a link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/activate`<br>

        To deactivate a link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`<br>

        To get a list of all one-time payments links, see `GET
        /pay-int-api/quick-payments/one-time`<br>

        To get details for a specified one-time payments link, see `POST
        /pay-int-api/quick-payments/one-time/{{quickPaymentId}}`
      parameters:
        - name: quickPaymentId
          $ref: '#/components/parameters/quickpaymentid'
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The request containing the details for the SMS notification.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.SmsNotification.SendIsvQuickPaymentSmsNotificationRequest
      responses:
        '200':
          description: OK
  /pay-int-api/quick-payments/reusable:
    post:
      tags:
        - Quick Payments
      summary: Creates a reusable payment link
      operationId: flute-v1-post-pay-int-api-quick-payments-reusable
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/reusable</span>


        This endpoint creates link for a quick reusable payment.
            
        A reusable payment is one that can be used multiple times and remains
        active after each use.

        This can be used for cases like donations or event registration fees.

        It is not limited to the same person each time.

        A reusable payment is in contrast to the one-time payment that expires
        after a single time.


        The link must be activated before use as a security feature.

        To activate a reusable link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/activate`


        The link remains active until one of the following occurs:

        * The link is manually deactivated

        * The link's time limit expires


        <span class="api-seealso">See Also:</span><br>

        To deactivate a link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`<br>

        To get a list of all reusable payments links, see `GET
        /pay-int-api/quick-payments/reusable`<br>

        To get details for a specified reusable link, see `POST
        /pay-int-api/quick-payments/reusable/{{quickPaymentId}}`}}`
      parameters:
        - name: x-api-version
          in: header
          schema:
            type: string
      requestBody:
        description: The payment link creation request.
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.Create.CreateIsvReusableQuickPaymentRequest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentResponse
    get:
      tags:
        - Quick Payments
      summary: Lists reusable links
      operationId: flute-v1-get-pay-int-api-quick-payments-reusable
      description: >
        <span class="api-endpoint">GET {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/reusable</span>


        This endpoint returns a list of reusable links.


        The links may be valid or expired.


        The request may be filtered to limit returns to the specified search.


        <span class="api-seealso">See Also:</span><br>

        To create a reusable payment link, see `POST
        /pay-int-api/quick-payments/reusable`<br>

        To deactivate a link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`<br>

        To get details for a specified reusable link, see `POST
        /pay-int-api/quick-payments/reusable/{{quickPaymentId}}`}}
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pagesize'
        - $ref: '#/components/parameters/orderby'
        - $ref: '#/components/parameters/asc'
        - name: status
          in: query
          description: >
            Payment link status.


            Possible values:


            | Status ID | Status    | Description |

            | :-------: |-----------|-------------|

            | 1         | Active    | The link is active and can be used.      
            |

            | 2         | Inactive  | The link is inactive and cannot be used. 
            |

            | 3         | Expired   | The link is inactive by timing out.      
            |

            | 4         | Completed | The link is inactive by having been used
            successfully. |
          schema:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.GetPage.GetIsvReusableQuickPaymentPageResponse
  /pay-int-api/quick-payments/reusable/{quickPaymentId}:
    get:
      tags:
        - Quick Payments
      summary: Retrieves details of a reusable link
      operationId: flute-v1-get-pay-int-api-quick-payments-reusable-quickPaymentId
      description: >
        <span class="api-endpoint">POST {{<a
        href="#urlbases">baseURL</a>}}/pay-int-api/quick-payments/reusable/{{quickPaymentId}}</span>


        This endpoint retrieves details of a specified reusable payment.


        The link may be valid or expired.


        <span class="api-seealso">See Also:</span><br>

        To create a reusable payment link, see `POST
        /pay-int-api/quick-payments/reusable`<br>

        To deactivate a link, see `POST
        /pay-int-api/quick-payments/{{quickPaymentId}}/deactivate`<br>

        To get details for a specified reusable link, see `POST
        /pay-int-api/quick-payments/reusable/{{quickPaymentId}}`}}`
      parameters:
        - $ref: '#/components/parameters/quickpaymentid'
        - name: x-api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.Get.GetIsvReusableQuickPaymentResponse
components:
  securitySchemes:
    Bearer:
      type: http
      description: Specify the authorization token.
      scheme: bearer
      bearerFormat: JWT
  schemas:
    AspNet.Swagger.Examples.ValidationExceptionExample:
      type: object
      properties:
        details:
          type: string
          nullable: true
          description: >
            Indicates details about the error.


            Example: Validation failed: -- Email: 'Email' is not a valid email
            address. Severity: Error
          example: >-
            Validation failed: -- Email: 'Email' is not a valid email address.
            Severity: Error
        statusCode:
          type: integer
          format: int32
          nullable: true
          description: >
            Specifies the HTTP response status code.


            This is the HTTP status code returned by the attempted delivery.


            The following is a list of HTTP response status codes that include
            but are not limited to:


            | HTTP Status | Meaning |

            |:-----------:|---------|

            | 200 | Delivery succeeded |

            | 400 | Bad request |

            | 401 | Unauthorized |

            | 404 | Endpoint not found |

            | 429 | Rate limited |


            Example: 401
          example: 401
        source:
          type: string
          nullable: true
          description: |
            Indicates the source of the error.

            Example: &lt;Service&gt;
          example: <Service>
        exceptionType:
          type: string
          nullable: true
          description: |
            Indicates the error's exception type.

            Example: FluentValidation.ValidationException
          example: FluentValidation.ValidationException
        correlationId:
          type: string
          nullable: true
          description: |
            Indicates the correlation identifier.

            Example: aa6cfcd0-0295-4a4c-b074-8c901f114fef
          example: aa6cfcd0-0295-4a4c-b074-8c901f114fef
        entityId:
          type: string
          nullable: true
          description: |
            Indicates the entity identifier.

            Example:<br>
              null
        errorCode:
          type: string
          nullable: true
          description: |
            Indicates the error code.

            Example:<br>
            null
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            description: |
              Indicates the precise error.

              Example:
            example:
              - Email
            nullable: true
          nullable: true
      additionalProperties: false
    CommonExceptionExample:
      type: object
      properties:
        details:
          type: string
          x-method: response
          nullable: true
          description: >
            Indicates details about the error.


            Example: Validation failed: -- Email: 'Email' is not a valid email
            address. Severity: Error
          example: >-
            Validation failed: -- Email: 'Email' is not a valid email address.
            Severity: Error
        statusCode:
          type: integer
          format: int32
          x-method: response
          nullable: true
          description: >
            Specifies the HTTP response status code.


            This is the HTTP status code returned by the attempted delivery.


            The following is a list of HTTP response status codes that include
            but are not limited to:


            | HTTP Status | Meaning |

            |:-----------:|---------|

            | 200 | Delivery succeeded |

            | 400 | Bad request |

            | 401 | Unauthorized |

            | 404 | Endpoint not found |

            | 429 | Rate limited |


            Example: 401
          example: 401
        source:
          type: string
          x-method: response
          nullable: true
          description: |
            Indicates the source of the error.

            Example: &lt;Service&gt;
          example: <Service>
        exceptionType:
          type: string
          x-method: response
          nullable: true
          description: |
            Indicates the error's exception type.

            Example: FluentValidation.ValidationException
          example: FluentValidation.ValidationException
        correlationId:
          type: string
          x-method: response
          nullable: true
          description: |
            Indicates the correlation identifier.

            Example: aa6cfcd0-0295-4a4c-b074-8c901f114fef
          example: aa6cfcd0-0295-4a4c-b074-8c901f114fef
        entityId:
          type: string
          x-method: response
          nullable: true
          description: |
            Indicates the entity identifier.

            Example:<br>
            null
        errorCode:
          type: string
          x-method: response
          nullable: true
          description: |
            Indicates the error code.

            Example:<br>
            null
        title:
          type: string
          x-method: response
          nullable: true
        cause:
          type: string
          x-method: response
          nullable: true
        resolution:
          type: string
          x-method: response
          nullable: true
        documentationUrl:
          type: string
          x-method: response
          nullable: true
      additionalProperties: false
    AspNet.Swagger.Examples.NotFoundExceptionExample:
      type: object
      properties:
        details:
          type: string
          nullable: true
        statusCode:
          type: integer
          format: int32
          nullable: true
          description: >
            Specifies the HTTP response status code.


            This is the HTTP status code returned by the attempted delivery.


            The following is a list of HTTP response status codes that include
            but are not limited to:


            | HTTP Status | Meaning |

            |:-----------:|---------|

            | 200 | Delivery succeeded |

            | 400 | Bad request |

            | 401 | Unauthorized |

            | 404 | Endpoint not found |

            | 429 | Rate limited |


            Example: 401
          example: 401
        source:
          type: string
          nullable: true
        exceptionType:
          type: string
          nullable: true
        correlationId:
          type: string
          nullable: true
        entityId:
          type: string
          nullable: true
        errorCode:
          type: string
          nullable: true
      additionalProperties: false
    ach_paymentmethodid:
      type: string
      description: |
        Identifies the customer payment method identifier.

        We recommend using `paymentMethodId` instead of `accountNumber`.

        Example: b6df8625-cd25-4123-b345-638aa7b5d011
      example: b6df8625-cd25-4123-b345-638aa7b5d011
      format: uuid
      nullable: true
    ach_accountnumber:
      type: string
      description: |
        Specifies the payment target's bank account number.

        We recommend using `paymentMethodId` instead of `accountNumber`.

        Example: 5413591081013511
      example: '5413591081013511'
      nullable: true
    ach_routingnumber:
      type: string
      description: |
        Specifies the payment target's bank routing number.

        Example: 026009593
      example: '026009593'
      nullable: true
    PaymentGateway.Contracts.Enums.Ach.AchSECCode:
      type: integer
      description: >
        <br>Specifies the SEC (standard entry class) code for the payment
        method.


        Allowed values:</p>


        | Type ID | Entry Type | Description |

        | :-----: |------------|-------------|

        | 1       | Web        | Internet-initiated/mobile entries. Default
        value. |

        | 2       | PPD        | Prearranged payment and deposit
        entries.          |

        | 3       | CCD        | Corporate credit or
        debit.                        |

        | 4       | Telephone  | Telephone-initiated
        entries.                      |


        Example: 1
      example: 1
      format: int32
      default: 1
    ach_customerid:
      type: string
      description: |
        Specifies the customer identifier.

        Example: 87d8e330-2878-4742-a86f-dbbb3bf522ac
      example: 87d8e330-2878-4742-a86f-dbbb3bf522ac
      format: uuid
      nullable: true
    ach_isfasterprocessing:
      type: boolean
      default: false
      description: >
        Specifies ACH (automated clearing house) transaction has same day
        processing enabled.


        Must be empty or null for card subscriptions.


        If `true`, same day processing is enabled.<br>

        If `false`, same day processing is not enabled.


        Example: false
      example: false
    ach_taxid:
      type: string
      description: |
        Specifies the customer's TIN (tax identifier).

        Example: 98-7654321
      example: 98-7654321
      nullable: true
    PaymentGateway.Contracts.Enums.AccountType:
      type: integer
      description: |
        Identifies the account type.

        Possible values:

        | Type ID | Account Type | Description |
        | :-----: |--------------|-------------|
        | 1       | Checking     | Checking    |
        | 2       | Savings      | Savings     |

        Example: 1
      example: 1
      format: int32
    PaymentGateway.Contracts.Enums.AccountHolderType:
      type: integer
      description: |
        Identifies the account holder type.

        Possible values:

        | Type ID | Account Type | Description |
        | :-----: |--------------|-------------|
        | 1       | Business     | Business    |
        | 2       | Personal     | Personal    |

        Example: 1
      example: 1
      format: int32
    PaymentGateway.Contracts.Transactions.AddressDto:
      type: object
      required:
        - city
        - countryId
      description: |
        Specifies an object defining the address.
      properties:
        city:
          type: string
          description: |
            Specifies the name of the city.

            Example: Chicago
          example: Chicago
          nullable: true
        countryId:
          type: integer
          description: >
            Specifies the <a href="#flute-countries-codes">Flute country
            identifier</a>.


            Example: 1
          example: 1
          format: int32
          nullable: true
        line1:
          type: string
          description: |
            Specifies the street address.

            Example: 322 Unicorn Boulevard
          example: 322 Unicorn Boulevard
          nullable: true
        line2:
          type: string
          description: |
            Specifies additional street address information.

            Example: Apt. Block 6
          example: Apt. Block 6
          nullable: true
        postalCode:
          type: string
          minLength: 2
          maxLength: 15
          description: |
            Specifies the postal or ZIP code.

            Examples:<br>
            60601<br>
            60601-0001
          example: 60601-0001
          nullable: true
        stateName:
          type: string
          description: |
            Indicates the full state name.

            Examples:<br>
            Texas<br>
            Washington<br>
            Illinois
          example: Illinois
          nullable: true
        stateId:
          type: integer
          description: >
            Specifies the <a href="#flute-states-codes">Flute US state or
            territory identifier code</a>.


            Example: 1
          example: 1
          format: int32
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Transactions.ContactInfoDto:
      type: object
      required:
        - companyName
      properties:
        companyName:
          type: string
          description: |
            Indicates the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: Peppared Street Cafe
        firstName:
          type: string
          nullable: true
          description: |
            Indicates the customer's first name.

            Example: Alexandro
          example: Alexandro
        lastName:
          type: string
          nullable: true
          description: |
            Indicates the customer's last name.

            Example: Peppared
          example: Peppared
        email:
          type: string
          nullable: true
          description: |
            Indicates the customer's email.

            Example: peppared@example.com
          example: peppared@example.com
        mobilePhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Indicates the customer's mobile phone number.

            Example: +15551234567
          example: '+15551234567'
          nullable: true
        smsNotification:
          type: boolean
          nullable: true
          default: false
          description: |
            Specifies the customer is sent an SMS notification.

            If `true`, the customer is sent an SMS notification.<br>
            If `false`, the customer is not sent an SMS notification.

            Example: true
          example: true
      additionalProperties: false
      description: |
        This group contains the customer's contact details.
    PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.CreateAchRefundRequest:
      required:
        - amount
        - paymentProcessorId
        - secCode
        - requesterIPaddress
        - paymentMethodId
      type: object
      properties:
        amount:
          type: number
          description: |
            Specifies the payment amount.

            Example: 129.99
          example: 129.99
          format: double
        paymentProcessorId:
          type: string
          format: uuid
          description: >
            Specifies the ACHQ (ACH check) payment processor identifier.


            A list of available payment processers can be found with `GET
            {{baseURL}}/pay-api/v1/configurations/payments`.

            See response `availablePaymentProcessors.id`.<br>

            If omitted, the merchant's default payment processor will be used.


            Example: f4e41489-aea6-4279-b6f1-e1f9bffd5358
          example: f4e41489-aea6-4279-b6f1-e1f9bffd5358
        paymentMethodId:
          $ref: '#/components/schemas/ach_paymentmethodid'
        accountNumber:
          $ref: '#/components/schemas/ach_accountnumber'
        routingNumber:
          $ref: '#/components/schemas/ach_routingnumber'
        secCode:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.Ach.AchSECCode'
        requesterIPaddress:
          type: string
          maxLength: 45
          minLength: 1
          description: >
            Specifies the IP address of the end user.


            This is an IPv4 or IPv6 address.

            This may be the customer, operator, or application responsible for
            submitting the transaction.


            Examples:<br>

            192.168.1.1<br>

            2001:0db8:85a3:0000:0000:8a2e:0370:7334
          example: 192.168.1.1
        customerId:
          $ref: '#/components/schemas/ach_customerid'
        isFasterProcessing:
          $ref: '#/components/schemas/ach_isfasterprocessing'
        taxId:
          $ref: '#/components/schemas/ach_taxid'
        accountType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.AccountType'
        accountHolderType:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.AccountHolderType
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        contactInfo:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto
      additionalProperties: false
    ach_transactionid:
      type: string
      format: uuid
      description: |
        Indicates the transaction identifier.

        Example: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff
      example: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff
    ach_typeid:
      type: integer
      format: int32
      description: >
        Indicates the <a href="#flute-transaction-types">Flute ACH (automated
        clearing house) transaction type code</a>.


        Example: 6
      example: 6
    ach_type:
      type: string
      nullable: true
      description: >
        Indicates the <a href="#flute-transaction-types">Flute ACH transaction
        type</a>.


        Example: CardAuthentication
      example: CardAuthentication
    ach_statusid:
      type: integer
      format: int32
      description: >
        Indicates the <a href="#flute-transaction-statuses">Flute ACH
        transaction status code</a>.


        Example: 1
      example: 1
    ach_status:
      type: string
      nullable: true
      description: >
        Indicates the <a href="#flute-transaction-statuses">Flute ACH
        transaction status type</a>.


        Example: Authorized
      example: Authorized
    ach_responsedescription:
      type: string
      nullable: true
      description: |
        Indicates a free-formed description regarding the transaction.

        Example: Command Successful. Approved.
      example: Command Successful. Approved.
    ach_responsecode:
      type: string
      nullable: true
      description: |
        Indicates a response code regarding the transaction.

        Example: 000
      example: '000'
    PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchPaymentResponse:
      type: object
      properties:
        transactionId:
          $ref: '#/components/schemas/ach_transactionid'
        typeId:
          $ref: '#/components/schemas/ach_typeid'
        type:
          $ref: '#/components/schemas/ach_type'
        statusId:
          $ref: '#/components/schemas/ach_statusid'
        status:
          $ref: '#/components/schemas/ach_status'
        responseDescription:
          $ref: '#/components/schemas/ach_responsedescription'
        responseCode:
          $ref: '#/components/schemas/ach_responsecode'
        processedAmount:
          type: number
          format: double
          description: |
            Indicates the transaction amount (in USD).

            Example: 3500.00
          example: 3500
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.CreateAchPaymentRequest:
      required:
        - amount
        - paymentProcessorId
        - secCode
        - requesterIPaddress
      type: object
      properties:
        amount:
          type: number
          format: double
          description: |
            Specifies the payment amount.

            Example: 129.99
          example: 129.99
        paymentProcessorId:
          type: string
          description: >
            Specifies the ACHQ (ACH check) payment processor identifier.


            A list of available payment processers can be found with `GET
            {{baseURL}}/pay-api/v1/configurations/payments`.

            See response `availablePaymentProcessors.id`.<br>

            If omitted, the merchant's default payment processor will be used.


            Example: f4e41489-aea6-4279-b6f1-e1f9bffd5358
          example: f4e41489-aea6-4279-b6f1-e1f9bffd5358
          format: uuid
        secCode:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.Ach.AchSECCode'
        requesterIPaddress:
          type: string
          maxLength: 45
          minLength: 1
          description: >
            Specifies the IP address of the end user.


            This is an IPv4 or IPv6 address.

            This may be the customer, operator, or application responsible for
            submitting the transaction.


            Examples:<br>

            192.168.1.1<br>

            2001:0db8:85a3:0000:0000:8a2e:0370:7334
          example: 192.168.1.1
        paymentMethodId:
          type: string
          description: >
            Specifies the customer payment method identifier.


            <span style="display:block; background-color:#f0f0f0; padding:8px
            10px;">

            Providing this value indicates the transaction uses a stored bank
            account.

            If this value is included, `customerId` must also be included.

            </span>


            Example: b6df8625-cd25-4123-b345-638aa7b5d011
          example: b6df8625-cd25-4123-b345-638aa7b5d011
          format: uuid
          nullable: true
        customerId:
          type: string
          description: >
            Specifies the customer identifier.


            <span style="display:block; background-color:#f0f0f0; padding:8px
            10px;">

            Providing this value indicates the transaction uses a stored bank
            account.

            This value is required if `paymentMethodId` is provided.

            </span>

            <br>

            <span style="display:block; background-color:#f0f0f0; padding:8px
            10px;">

            Providing this value without also providing `paymentMethodId`
            indicates the transaction does not use a stored bank account.

            In this case, a new customer will automatically be generated.

            </span>


            Example: 87d8e330-2878-4742-a86f-dbbb3bf522ac
          example: 87d8e330-2878-4742-a86f-dbbb3bf522ac
          format: uuid
          nullable: true
        accountNumber:
          $ref: '#/components/schemas/ach_accountnumber'
        routingNumber:
          $ref: '#/components/schemas/ach_routingnumber'
        accountType:
          type: integer
          description: >
            Identifies the account type.


            <span style="display:block; background-color:#f0f0f0; padding:8px
            10px;">

            This value is required when the transaction is not using a stored
            bank account.

            </span>


            Possible values:


            | Type ID | Account Type | Description |

            | :-----: |--------------|-------------|

            | 1       | Checking     | Checking    |

            | 2       | Savings      | Savings     |


            Example: 1
          example: 1
          format: int32
        accountHolderType:
          type: integer
          description: >
            Identifies the account holder type.


            <span style="display:block; background-color:#f0f0f0; padding:8px
            10px;">

            This value is required when the transaction not using a stored bank
            account.

            </span>


            Possible values:


            | Type ID | Account Type | Description |

            | :-----: |--------------|-------------|

            | 1       | Business     | Business    |

            | 2       | Personal     | Personal    |


            Example: 1
          example: 1
          format: int32
        contactInfo:
          allOf:
            - $ref: >-
                #/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto
          description: >
            <span style="display:block; background-color:#f0f0f0; padding:8px
            10px;">

            This object is required when the transaction is not using a stored
            bank account.

            </span>
        billingAddress:
          allOf:
            - $ref: >-
                #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
          description: >
            <span style="display:block; background-color:#f0f0f0; padding:8px
            10px;">

            This object is required when the transaction is not using a stored
            bank account.

            </span>
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        isFasterProcessing:
          $ref: '#/components/schemas/ach_isfasterprocessing'
        taxId:
          $ref: '#/components/schemas/ach_taxid'
      additionalProperties: false
    AspNet.Swagger.Examples.InternalExceptionExample:
      type: object
      properties:
        details:
          type: string
          nullable: true
        statusCode:
          type: integer
          format: int32
          nullable: true
          description: >
            Specifies the HTTP response status code.


            This is the HTTP status code returned by the attempted delivery.


            The following is a list of HTTP response status codes that include
            but are not limited to:


            | HTTP Status | Meaning |

            |:-----------:|---------|

            | 200 | Delivery succeeded |

            | 400 | Bad request |

            | 401 | Unauthorized |

            | 404 | Endpoint not found |

            | 429 | Rate limited |


            Example: 401
          example: 401
        source:
          type: string
          nullable: true
        exceptionType:
          type: string
          nullable: true
        correlationId:
          type: string
          nullable: true
        entityId:
          type: string
          nullable: true
        errorCode:
          type: string
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.AchTransactions.AchResponse:
      type: object
      properties:
        transactionId:
          $ref: '#/components/schemas/ach_transactionid'
        typeId:
          $ref: '#/components/schemas/ach_typeid'
        type:
          $ref: '#/components/schemas/ach_type'
        statusId:
          $ref: '#/components/schemas/ach_statusid'
        status:
          $ref: '#/components/schemas/ach_status'
        responseDescription:
          $ref: '#/components/schemas/ach_responsedescription'
        responseCode:
          $ref: '#/components/schemas/ach_responsecode'
      additionalProperties: false
    PaymentGateway.Contracts.Enums.ZeroCostProcessingOption:
      type: integer
      description: |
        <br>Identifies the zero cost processing option.

        Possible values:

        | Id | Type         |
        |:--:|--------------|
        | 1  | None         |
        | 2  | CashDiscount |
        | 3  | DualPricing  |
        | 4  | Surcharge    |

        Example: 3
      example: 3
      format: int32
    PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.EnumDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
          description: |
            Indicates the currency identifier.

            Example: 1  (for USD)
          example: 1
        name:
          type: string
          description: |
            Indicates the currency (in ISO 4217 alpha-3 currency code format).

            Example: USD
          example: USD
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.SettlementBatchTimeSlot:
      type: object
      properties:
        hours:
          type: integer
          format: int32
          description: >
            Indicates the hour (in 24-hour format, 0 - 23) of the batch
            settlement.


            Examples:<br>

            1<br>

            09<br>

            15<br>

            23<br>
        minutes:
          type: integer
          format: int32
          description: |
            Indicates the minute (0 - 59) of the batch settlement.

            Examples:<br>
            00<br>
            15<br>
            49<br>
        timezoneName:
          type: string
          nullable: true
          description: >
            Indicates the time zone (in IANA Time Zone Identifier) of the batch
            settlement.


            Example: America/New_York
          example: America/New_York
      additionalProperties: false
    PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.PaymentProcessorDto:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the payment processor identifier.

            Example: 965865ef-b17d-4153-b952-d8902e584f7d
          example: 965865ef-b17d-4153-b952-d8902e584f7d
          format: uuid
        name:
          type: string
          nullable: true
          description: |
            Indicates the name of the payment processor.

            Example: TSYS
          example: TSYS
        typeId:
          type: integer
          format: int32
          description: |
            Indicates the payment processor type identifier.

            Possible values are:

            | Id | Name |
            |----|------|
            | 1  | TSYS |
            | 2  | EFT  |

            Example: 1
          example: 1
        type:
          type: string
          nullable: true
          description: |
            Indicates the payment processor type.

            Possible values are:

            | Name | Id |
            |------|:--:|
            | TSYS | 1  |
            | EFT  | 2  |

            Example:TSYS
          example: TSYS
        isDefault:
          type: boolean
          description: |
            Indicates this is the default payment processor.

            If `true`, this is the default payment processor.<br>
            If `false`, this is not the default payment processor.

            Example: true
          example: true
        settlementBatchTimeSlots:
          type: array
          description: >
            <br>Indicates an object describing the scheduled time windows for
            settlement batch processing.
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.SettlementBatchTimeSlot
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.AvsOptions:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: |
            Indicates the AVS (address verification service) is enabled.

            If `true`, AVS is enabled.<br>
            If `false`, AVS is not enabled.

            Example: true
          example: true
        profileId:
          type: integer
          format: int32
          description: >
            Indicates the profile type identifier of the AVS (address
            verification service) configuration.


            Example: 1
          example: 1
        profile:
          type: string
          nullable: true
          description: >
            Indicates the profile type of the AVS (address verification service)
            configuration.


            The profile type specifies the strictness or leniency of the
            validation and fraud controls on transactions.

            Values may include lenient, normal, strict, or custom.

            The actual values may vary.


            Example: strict
          example: strict
      additionalProperties: false
    PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto:
      type: object
      properties:
        zeroCostProcessingOptionId:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.ZeroCostProcessingOption
        zeroCostProcessingOption:
          type: string
          description: |
            Zero cost processing option name.

            Possible values:

            | Id           | Value |
            |--------------|:-----:|
            | None         | 1     |
            | CashDiscount | 2     |
            | DualPricing  | 3     |
            | Surcharge    | 4     |

            Example: DualPricing
          example: DualPricing
          nullable: true
        defaultTipsOptions:
          type: array
          description: >
            Identifies an array of default, or preselected, tip options.


            These values could be displayed on a receipt as preselected tip
            value options.

            The client's app and UX needs to support that display.

            They are presented as a percent alongside the actual money amount.

            The intent is to present these values from which clients can quickly
            select a tip amount.

            They are suggestions presented only as a convenience to the client.

            The client should be able to select any value, a custom value, or no
            value.


            These values are configured by the merchant.


            Example: [10, 15.25, 20.5]
          example:
            - 10
            - 15.25
            - 20.5
          items:
            maxItems: 3
            minItems: 0
            type: number
            format: double
          nullable: true
        isTipsEnabled:
          type: boolean
          description: >
            Indicates tips are enabled.


            If `true`, tips are enabled.<br>

            If `false`, tips are not enabled.

            Transactions with tip values will fail with a 400 response.

            This also includes the one-step transaction `POST
            {{baseURL}}/pay-api/v1/transactions/sale`.


            Tips are enabled or disabled in the <a
            href="https://dashboard.flute.com/login" target="_blank"
            rel="noopener noreferrer">Sandbox Merchant dashboard</a>.


            Example: true
          example: true
        defaultSurchargeRate:
          type: number
          format: double
          nullable: true
          description: |
            Identifies the default surcharge rate.

            This value is configured by the merchant.

            Example: 3.5
          example: 3.5
        defaultCashDiscountRate:
          type: number
          format: double
          nullable: true
          description: |
            Identifies the default cash discount rate.

            This value is configured by the merchant.

            Example: 3.5 (as 3.5%)
          example: 3.5
        defaultDualPricingRate:
          type: number
          format: double
          nullable: true
          description: >
            Identifies the default dual pricing rate.


            Dual pricing is when the merchant displays two prices for the same
            product.

            For example, for cash or credit card.

            The dual pricing rate is the additional charge for the other price,
            such as with a credit card.


            This value is configured by the merchant.


            Example: 3.5 (as 3.5%)
          example: 3.5
        availableCurrencies:
          description: |
            <br>Identifies the available currencies
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.EnumDto
          nullable: true
        availableCardTypes:
          description: <br>Available card types.
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                format: int32
                description: >
                  Indicates the <a href="#card-types">Flute credit card type
                  identifier code</a>.


                  Example: 2
                example: 2
              name:
                type: string
                description: >
                  Indicates the <a href="#card-types">name of the credit
                  card</a>.


                  Example: MasterCard
                example: MasterCard
                nullable: true
            additionalProperties: false
          nullable: true
        availableTransactionTypes:
          type: array
          nullable: true
          description: |
            Indicates available transactions types.
          items:
            type: object
            properties:
              id:
                type: integer
                format: int32
                description: >
                  Indicates the <a href="#flute-transaction-types">Flute
                  transaction type identifier code</a>.


                  Example: 6
                example: 6
              name:
                type: string
                description: >
                  Indicates the <a href="#flute-transaction-types">name of the
                  transaction type.</a>.


                  Example: CardAuthentication
                example: CardAuthentication
                nullable: true
            additionalProperties: false
        availablePaymentProcessors:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.PaymentProcessorDto
          description: <br>Available payment processors.
          nullable: true
        avs:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Configurations.Payments.GetPaymentConfigurationsResponseDto.AvsOptions
        isCustomerCardSavingByTerminalEnabled:
          type: boolean
          description: >
            Indicates the terminal saves the customer's card after the
            transaction is processed.


            If `true`, the customer's card is saved.<br>

            If `false`, the customer's card is not saved.


            Example: true
          example: true
        companyName:
          type: string
          description: |
            Indicates the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: Peppared Street Cafe
          nullable: true
        mccCode:
          type: string
          description: |
            Indicates the <a href="#mcc-codes">MCC (merchant category code)</a>.

            Example: 28
          example: '28'
          nullable: true
        mccCodeDescription:
          type: string
          description: |
            Indicates the merchant category code description.

            Example: Hospitals
          example: Hospitals
          nullable: true
        currencyId:
          type: integer
          description: |
            Indicates the currency identifier.

            Possible values can be found in `AvailableCurrencies`.

            Example: 1  (for USD)
          example: 1
          format: int32
        currencyIsoCode:
          type: string
          description: |
            Indicates the currency (in ISO 4217 alpha-3 currency code format).

            Example: USD
          example: USD
          nullable: true
        maxTransactionAmount:
          type: number
          description: |
            Indicates the maximum transaction amount limit.

            Example: 32000
          example: 32000
          format: double
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse.ContactInfo:
      type: object
      properties:
        id:
          type: string
          description: |
            The identifier of the contact information record.

            Example: 24d5e6f7-8a9b-4c0d-1e2f-3a4b5c6d7e03
          example: 24d5e6f7-8a9b-4c0d-1e2f-3a4b5c6d7e03
          format: uuid
        addressName:
          type: string
          description: |
            The name or label of the address.

            Examples:<br>
            Main Office<br>
            Warehouse
          example: Main Office
          nullable: true
        addressLine1:
          type: string
          description: |
            Specifies the street address.

            Example: 322 Unicorn Boulevard
          example: 322 Unicorn Boulevard
          nullable: true
        addressLine2:
          type: string
          description: |
            Specifies additional street address information.

            Example: Office 3
          example: Office 3
          nullable: true
        city:
          type: string
          description: |
            Indicates the name of the city.

            Example: Chicago
          example: Chicago
          nullable: true
        zip:
          type: string
          description: |
            Indicates the postal or ZIP code.

            Examples:<br>
            60612<br>
            60612-0001
          example: '60612'
          nullable: true
        countryId:
          type: integer
          description: >
            Specifies the <a href="#flute-countries-codes">Flute country
            identifier</a>.


            Example: 1
          example: 1
          format: int32
        stateId:
          type: integer
          description: >
            Specifies the <a href="#flute-states-codes">Flute US state or
            territory identifier code</a>.


            Example: 4
          example: 4
          format: int32
          nullable: true
        stateName:
          type: string
          description: |
            Indicates the full state name.

            Examples:<br>
            Texas<br>
            Washington<br>
            Illinois
          example: Illinois
          nullable: true
        email:
          type: string
          description: |
            The email address associated with this contact information.

            Example: pepparedstreetcafe@example.com
          example: pepparedstreetcafe@example.com
          nullable: true
        businessPhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            The business phone number for this contact.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        merchantId:
          type: string
          description: |
            Indicates the identifier of the merchant.

            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          format: uuid
        isMainAddress:
          type: boolean
          description: |
            Indicates this is the main address for the merchant.

            If `true`, this is the main address for the merchant.<br>
            If `false`, this is not the main address for the merchant.

            Example: true
          example: true
        isDefaultAddress:
          type: boolean
          description: |
            Indicates this is the default address used for the merchant.

            If `true`, this is the default address used for the merchant.<br>
            If `false`, this is not the default address used for the merchant.

            Example: true
          example: true
      additionalProperties: false
      description: Represents a single contact information record for a merchant.
    PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse:
      type: object
      properties:
        contactInfos:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Configurations.MerchantContactInfos.GetMerchantContactInfosResponse.ContactInfo
          description: A list of contact information entries associated with the merchant.
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Common.StateDto:
      type: object
      properties:
        id:
          type: integer
          description: |
            Indicates the state identifier.

            Example: 13
          format: int32
        code:
          type: string
          description: >
            Indicates the state identifier (in two-letter USPS [United States
            Postal Service] postal code).


            Examples:<br>

            IL<br>

            TX<br>

            MA
          example: IL
          nullable: true
        name:
          type: string
          description: |
            Indicates the name of the state.

            Example: Illinois
          example: Illinois
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Common.CountryDto:
      type: object
      properties:
        id:
          type: integer
          description: |
            Indicates the country identifier.

            Example: 1
          example: 1
          format: int32
        isoCode:
          type: string
          description: |
            Indicates the country identifier (in two letter ISO 3166-1 format).

            Example: US
          example: US
          nullable: true
        name:
          type: string
          description: |
            Indicates the name of the country.

            Example: United States
          example: United States
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Common.AddressDto:
      type: object
      properties:
        addressLine1:
          type: string
          description: |
            Indicates the street address.

            Example: 21 E. Main Street
          example: 21 E. Main Street
          nullable: true
        addressLine2:
          type: string
          description: |
            Indicates additional street address information.

            Example: Office 3
          example: Office 3
          nullable: true
        city:
          type: string
          description: |
            Indicates the name of the city.

            Example: Chicago
          example: Chicago
          nullable: true
        zip:
          type: string
          description: |
            Indicates the postal or ZIP code.

            Examples:<br>
            60612<br>
            60612-0001
          example: '60612'
          nullable: true
        stateName:
          type: string
          description: |
            Indicates the full state name.

            Examples:<br>
            Texas<br>
            Washington<br>
            Illinois
          example: Illinois
          nullable: true
        state:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Common.StateDto
        country:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Common.CountryDto
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Common.CustomerItemDto:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the customer identifier.

            Example: 019bf058-960f-72a0-8194-6d554c7d6004
          example: 019bf058-960f-72a0-8194-6d554c7d6004
          format: uuid
        createdOn:
          type: string
          description: >
            Indicates the date the customer was created (in an ISO 8601
            date-time UTC format).


            Examples: 2025-01-27T12:05:54.322587Z
          example: '2025-01-27T12:05:54.322587Z'
          format: date-time
        modifiedOn:
          type: string
          description: >
            Indicates the date the customer information was last modified (in an
            ISO 8601 date-time UTC format).


            Examples:<br>

            2025-01-27T12:05:54.322587Z
          example: '2025-01-27T12:05:54.322587Z'
          format: date-time
        lastTransactionDate:
          type: string
          description: >
            Indicates the date of the customer's last transaction (in an ISO
            8601 date-time UTC format).


            Examples:<br>

            2025-01-27T12:05:54.322587Z
          example: '2025-01-27T12:05:54.322587Z'
          format: date-time
          nullable: true
        lastTransactionAmount:
          type: number
          description: |
            Indicates the amount of the customer's last transaction.

            Examples:<br>
            1600<br>
            249.99
          format: double
          nullable: true
        activeSubscriptionsAmount:
          type: number
          description: |
            Indicates the amount of all active subscriptions.

            Example: 1236.83
          format: double
          nullable: true
        contactName:
          type: string
          description: |
            Indicates the customer's contact name.

            Example: Alexandro Peppared
          example: Alexandro Peppared
          nullable: true
        firstName:
          type: string
          description: |
            Indicates the customer's first name.

            Example: Alexandro
          example: Alexandro
          nullable: true
        lastName:
          type: string
          description: |
            Indicates the customer's last name.

            Example: Peppared
          example: Peppared
          nullable: true
        companyName:
          type: string
          description: |
            Indicates the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: Peppared Street Cafe
          nullable: true
        email:
          type: string
          description: |
            Indicates the customer's email.

            Example: peppared@example.com
          example: peppared@example.com
          nullable: true
        mobilePhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Indicates the customer's mobile phone number.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        isMobileNumberSmsNotificationsEnabled:
          type: boolean
          description: |
            Indicates the customer's SMS notification is enabled.

            If `true`, the customer's SMS notification is enabled.<br>
            If `false`, the customer's SMS notification is not enabled.<br>
            If missing or omitted, the information is not available.

            Example: true
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Common.AddressDto
        paymentMethodsCount:
          type: integer
          description: |
            Indicates the number of the customer's payment methods.

            Example: 2
          format: int32
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.GetPage.GetCustomerPageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Customers.Common.CustomerItemDto
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of customers found.

            Example: 5
          example: 5
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.AddressDto:
      type: object
      properties:
        addressLine1:
          type: string
          description: |
            Specifies the street address.

            Example: 322 Unicorn Boulevard
          example: 322 Unicorn Boulevard
          nullable: true
        addressLine2:
          type: string
          description: |
            Specifies additional street address information.

            Example: Office 3
          example: Office 3
          nullable: true
        city:
          type: string
          description: |
            Specifies the name of the city.

            Example: Chicago
          example: Chicago
          nullable: true
        zip:
          type: string
          description: |
            Specifies the postal or ZIP code.

            Examples:<br>
            60612<br>
            60612-0001
          example: '60612'
          nullable: true
        stateName:
          type: string
          description: |
            Indicates the full state name.

            Examples:<br>
            Texas<br>
            Washington<br>
            Illinois
          example: Illinois
          nullable: true
        stateId:
          type: integer
          description: >
            Specifies the <a href="#flute-states-codes">Flute US state or
            territory identifier code</a>.


            Example: 4
          example: 4
          format: int32
          nullable: true
        countryId:
          type: integer
          description: >
            Specifies the <a href="#flute-countries-codes">Flute country
            identifier</a>.


            Example: 1
          example: 1
          format: int32
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodCardDto:
      type: object
      properties:
        name:
          type: string
          description: Payment method name
          nullable: true
        pan:
          type: string
          nullable: true
          description: |
            Specifies customer’s PAN (primary account number).

            This is the payment card number.

            Example: 411235455213655
          example: '411235455213655'
        expirationMonth:
          type: integer
          description: |
            Specifies the expiration month of the card.

            Example: 7
          example: 7
          format: int32
        expirationYear:
          type: integer
          format: int32
          expirationYear:
            type: integer
            format: int32
            description: |
              Specifies the expiration year of the card.

              Example: 2032
            example: 2032
        securityCode:
          type: string
          description: Security code
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodAchAccountDto:
      type: object
      properties:
        name:
          type: string
          nullable: true
        accountNumber:
          $ref: '#/components/schemas/ach_accountnumber'
        routingNumber:
          $ref: '#/components/schemas/ach_routingnumber'
        accountType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.AccountType'
        accountHolderType:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.AccountHolderType
        taxId:
          type: string
          nullable: true
          description: |
            Specifies the customer's TIN (tax identifier number).

            Example: 98-7654321
          example: 98-7654321
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.Create.CreateCustomerRequest:
      required:
        - firstName
        - lastName
      type: object
      properties:
        firstName:
          type: string
          description: |
            Specifies the customer's first name.

            Example: Alexandro
          example: Alexandro
        lastName:
          type: string
          description: |
            Indicates the customer's last name.

            Example: Peppared
          example: Peppared
        companyName:
          type: string
          description: |
            Specifies the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: Peppared Street Cafe
          nullable: true
        email:
          type: string
          description: |
            Indicates the customer's email.

            Example: peppared@example.com
          example: peppared@example.com
          nullable: true
        mobilePhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Indicates the customer's mobile phone number.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        isMobileNumberSmsNotificationsEnabled:
          type: boolean
          description: |
            Indicates the customer's SMS notification is enabled.

            If `true`, the customer's SMS notification is enabled.<br>
            If `false`, the customer's SMS notification is not enabled.<br>
            If missing or omitted, the information is not available.

            Example: true
        useBillingAsShippingAddress:
          type: boolean
          description: |
            Indicates to use the billing address as the shipping address.

            If `true`, use the billing address as the shipping address.<br>
            If `false`, do not use the billing address as the shipping address.
            Instead, use the field `shippingAddress`.

            Example: true
          example: true
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.AddressDto
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.AddressDto
        paymentMethodsCards:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodCardDto
          description: Payment methods
          nullable: true
        paymentMethodsAchAccounts:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Customers.Create.CreateCustomerRequestDto.PaymentMethodAchAccountDto
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.Create.CreateCustomerResponse:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the customerId or the customer identifier.

            Example: 965865ef-b17d-4153-b952-d8902e584f7d
          example: 965865ef-b17d-4153-b952-d8902e584f7d
          format: uuid
      additionalProperties: false
    PaymentGateway.Contracts.Enums.TokenType:
      type: integer
      description: |
        Identifies the card token type.

        Possible values:

        | Id | Type    | Description |
        |:--:|---------|-------------|
        | 1  | Local   | Regular     |
        | 2  | Network | Network     |

        Example: 2
      example: 2
      format: int32
    PaymentGateway.Contracts.Enums.CardType:
      type: integer
      description: |
        Identifies available card types (brands).

        This is a simplified list.
        For example Discover and Diners are the same.

        Possible values:

        | Id | Card Type       |
        |:--:|-----------------|
        | 0  | Unknown         |
        | 1  | Visa            |
        | 2  | MasterCard      |
        | 3  | AmericanExpress |
        | 4  | DinersClub      |
        | 5  | Discover        |
        | 6  | JCB             |

        Example: 1
      example: 1
      format: int32
    PaymentGateway.Contracts.Enums.CreditDebitType:
      type: integer
      description: |
        Possible values:

        | Value | Name    |
        |-------|---------|
        | 1     | Credit  |
        | 2     | Debit   |
        | 3     | Unknown |

        Example: 1
      example: 1
      format: int32
    PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodCardDto:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the credit card identifier.

            Example: db02ec6c-2e5a-4b87-98a0-8dd881707d84
          example: db02ec6c-2e5a-4b87-98a0-8dd881707d84
          format: uuid
        name:
          type: string
          description: Name
          nullable: true
        isDefault:
          type: boolean
          description: Is payment method default
        panMask:
          type: string
          nullable: true
          description: >
            Indicates the masked PAN (primary account number).


            This is a partially obscured representation of a card's PAN.

            This value can be safely displayed to clients without revealing the
            actual or full account number.


            Examples:<br>

            4111********1234<br>

            ************1234<br>

            ****1234
          example: 4111********1234
        expirationMonth:
          type: integer
          format: int32
          description: |
            Indicates the expiration month of the card.

            Example: 7
          example: 7
        expirationYear:
          type: integer
          format: int32
          description: |
            Indicates the expiration year of the card.

            Example: 2032
          example: 2032
        cardTokenType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.TokenType'
        cardType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.CardType'
        creditDebitType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.CreditDebitType'
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodAchAccountDto:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the ACH account identifier.

            Example: db02ec6c-2e5a-4b87-98a0-8dd881707d84
          example: db02ec6c-2e5a-4b87-98a0-8dd881707d84
          format: uuid
        name:
          type: string
          description: Name
          nullable: true
        isDefault:
          type: boolean
          description: Is payment method default.
        accountNumber:
          $ref: '#/components/schemas/ach_accountnumber'
        routingNumber:
          $ref: '#/components/schemas/ach_routingnumber'
        accountTypeId:
          type: integer
          format: int32
        accountType:
          type: string
          nullable: true
        accountHolderTypeId:
          type: integer
          format: int32
        accountHolderType:
          type: string
          nullable: true
        taxId:
          type: string
          nullable: true
          description: |
            Indicates the customer's TIN (tax identifier number).

            Example: 98-7654321
          example: 98-7654321
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.Get.GetCustomerResponse:
      type: object
      properties:
        id:
          type: string
          description: Customer Id
          format: uuid
        merchantId:
          type: string
          description: |
            Indicates the identifier of the merchant.

            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          format: uuid
        firstName:
          type: string
          description: |
            Indicates the customer's first name.

            Example: Alexandro
          example: Alexandro
          nullable: true
        lastName:
          type: string
          description: |
            Indicates the customer's last name.

            Example: Peppared
          example: Peppared
        companyName:
          type: string
          description: |
            Indicates the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: Peppared Street Cafe
          nullable: true
        email:
          type: string
          description: |
            Indicates the customer's email.

            Example: pepparedstreetcafe@example.com
          example: pepparedstreetcafe@example.com
          nullable: true
        mobilePhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Indicates the customer's mobile phone number.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        isMobileNumberSmsNotificationsEnabled:
          type: boolean
          description: |
            Indicates the customer's SMS notification is enabled.

            If `true`, the customer's SMS notification is enabled.<br>
            If `false`, the customer's SMS notification is not enabled.<br>
            If missing or omitted, the information is not available.

            Example: true
        useBillingAsShippingAddress:
          type: boolean
          description: |
            Indicates to use the billing address as the shipping address.

            If `true`, use the billing address as the shipping address.<br>
            If `false`, do not use the billing address as the shipping address.
            Instead, use the field `shippingAddress`.

            Example: true
          example: true
        defaultPaymentMethodId:
          type: string
          description: Default payment method Id
          format: uuid
          nullable: true
        defaultAchPaymentMethodId:
          type: string
          description: Default payment method identifier.
          format: uuid
          nullable: true
        createdOn:
          type: string
          description: >
            Indicates the date the customer was created on (in an ISO 8601
            date-time UTC format).


            Examples: 2025-01-27T12:05:54.322587Z
          example: '2025-01-27T12:05:54.322587Z'
          format: date-time
        modifiedOn:
          type: string
          description: >
            Indicates the date the customer information was last modified on (in
            an ISO 8601 date-time UTC format).


            Examples: 2025-01-27T12:05:54.322587Z
          example: '2025-01-27T12:05:54.322587Z'
          format: date-time
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Common.AddressDto
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Common.AddressDto
        lastTransactionDate:
          type: string
          description: >
            Indicates the last transaction date (in an ISO 8601 date-time UTC
            format).


            Examples: 2025-01-27T12:05:54.322587Z
          example: '2025-01-27T12:05:54.322587Z'
          format: date-time
          nullable: true
        transactionsCount:
          type: integer
          description: Transactions count
          format: int32
        transactionsVolume:
          type: number
          description: Transactions volume
          format: double
        lastTransactionAmount:
          type: number
          description: Last transaction amount
          format: double
          nullable: true
        numberOfSubscriptions:
          type: integer
          description: Count of active subscriptions
          format: int32
        cards:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodCardDto
          description: Payment methods
          nullable: true
        achAccounts:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Customers.Get.GetCustomerResponseDto.PaymentMethodAchAccountDto
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Customers.Update.UpdateCustomerRequestDto.AddressDto:
      type: object
      description: Specifies an object for a street address.
      properties:
        addressLine1:
          type: string
          description: |
            Specifies the street address.

            Example: 21 E. Main Street
          example: 21 E. Main Street
          nullable: true
        addressLine2:
          type: string
          description: |
            Specifies additional street address information.

            Example: Office 3
          example: Office 3
          nullable: true
        city:
          type: string
          description: |
            Specifies the name of the city.

            Example: Chicago
          example: Chicago
          nullable: true
        zip:
          type: string
          minLength: 2
          maxLength: 15
          description: |
            Specifies the postal or ZIP code.

            Examples:<br>
            60601<br>
            60601-0001
          example: 60601-0001
          nullable: true
        stateName:
          type: string
          description: |
            Specifies the full state name.

            Examples:<br>
            Texas<br>
            Washington<br>
            Illinois
          example: Illinois
          nullable: true
        stateId:
          type: integer
          description: >
            Specifies the <a href="#flute-states-codes">Flute US state or
            territory identifier code</a>.


            Example: 4
          example: 4
          format: int32
          nullable: true
        countryId:
          type: integer
          description: >
            Specifies the <a href="#flute-countries-codes">Flute country
            identifier</a>.


            Example: 1
          example: 1
          format: int32
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.Update.UpdateCustomerRequest:
      required:
        - firstName
        - lastName
      type: object
      properties:
        firstName:
          type: string
          description: |
            Specifies the customer's first name.

            Example: Alexandro
          example: Alexandro
        lastName:
          type: string
          description: |
            Specifies the customer's last name.

            Example: Peppared
          example: Peppared
        companyName:
          type: string
          description: |
            Specifies the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: Peppared Street Cafe
          nullable: true
        email:
          type: string
          description: |
            Specifies the customer's email

            Example: pepparedstreetcafe@example.com
          example: pepparedstreetcafe@example.com
          nullable: true
        mobilePhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Specifies the customer's mobile phone number.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        isMobileNumberSmsNotificationsEnabled:
          type: boolean
          description: |
            Specifies the customer's SMS notification is enabled.

            If `true`, the customer's SMS notification is enabled.<br>
            If `false`, the customer's SMS notification is not enabled.<br>
            If missing or omitted, the information is not available.

            Example: true
        useBillingAsShippingAddress:
          type: boolean
          description: |
            Specifies to use the billing address as the shipping address.

            If `true`, use the billing address as the shipping address.<br>
            If `false`, do not use the billing address as the shipping address.
            Instead, use the field `shippingAddress`.

            Example: true
          example: true
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Update.UpdateCustomerRequestDto.AddressDto
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Customers.Update.UpdateCustomerRequestDto.AddressDto
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodRequest:
      required:
        - expirationMonth
        - expirationYear
        - pan
      type: object
      properties:
        name:
          type: string
          description: >
            Specifies the payment method name.


            This is a free-formed name that is convenient for the merchant to
            recognize.


            Example: Cafe Peppared
          example: Cafe Peppared
          nullable: true
        pan:
          minLength: 1
          type: string
          description: |
            Specifies the customer’s PAN (primary account number).

            This is the payment card number.

            Example: 1234567890123
          example: '1234567890123'
        expirationMonth:
          type: integer
          format: int32
          description: |
            Specifies the expiration month of the card.

            Example: 7
          example: 7
        expirationYear:
          type: integer
          format: int32
          description: |
            Specifies the expiration year of the card.

            Example: 2032
          example: 2032
        securityCode:
          type: string
          description: Security code
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Create.CreatePaymentMethodResponse:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the payment method identifier.

            This is also known the `paymentMethodId`.

            Example: db02ec6c-2e5a-4b87-98a0-8dd881707d84
          example: db02ec6c-2e5a-4b87-98a0-8dd881707d84
          format: uuid
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Ach.Create.CreateAchAccountPaymentMethodRequest:
      required:
        - accountNumber
        - routingNumber
        - accountType
        - accountHolderType
      type: object
      properties:
        accountNumber:
          type: string
          description: |
            Specifies the account number.

            Example: 123456789
          example: '123456789'
          nullable: true
        routingNumber:
          minLength: 1
          type: string
          description: |
            Specifies the routing number.

            Example: 123123123
          example: '123123123'
        accountType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.AccountType'
        accountHolderType:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.AccountHolderType
        name:
          type: string
          description: >
            Specifies the payment method name.


            This is a free-formed name that is convenient for the merchant to
            recognize.


            Example: Peppared Street Cafe's Preferred Payment
          example: Peppared Street Cafe's Preferred Payment
        taxId:
          type: string
          description: |
            Specifies the customer's TIN (tax identifier number).

            Example: 98-7654321
          example: 98-7654321
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the paymentMethodId (payment method identifier).

            Example: 09af9936-08ec-4235-8386-b8d341cc88e7
          example: 09af9936-08ec-4235-8386-b8d341cc88e7
          format: uuid
        name:
          type: string
          description: >
            Specifies the payment method name.


            This is a free-formed name that is convenient for the merchant to
            recognize.


            Example: Peppared Street Cafe's Preferred Payment
          example: Peppared Street Cafe's Preferred Payment
        panMask:
          type: string
          description: >
            Indicates the masked PAN (primary account number).


            This is a partially obscured representation of a card's PAN.

            This value can be safely displayed to clients without revealing the
            actual or full account number.


            Examples:<br>

            4111********1234<br>

            ************1234<br>

            ****1234
          example: 4111********1234
          nullable: true
        isDefault:
          type: boolean
          description: |
            Indicates this payment method is the default.

            If `true`, this payment method is the default.<br>
            If `false`, this payment method is not the default.

            Example: true
          example: true
        typeId:
          type: integer
          description: |
            Indicates the type identifiers.

            Possible values:

            | Id | Payment Type     |
            |:--:|------------------|
            | 1  | Card             |
            | 2  | ElectronicCheck  |
            | 3  | Cash             |

            Example: 2
          example: 2
          format: int32
        typeName:
          type: string
          description: |
            Indicates the type name.

            Possible values:

            | Payment Type     |
            |------------------|
            | Card             |
            | ElectronicCheck  |
            | Cash             |

            Example: ElectronicCheck
          example: ElectronicCheck
          nullable: true
        expirationMonth:
          type: integer
          description: |
            Indicates the expiration month of the card.

            Example: 7
          example: 7
          format: int32
          nullable: false
        expirationYear:
          type: integer
          format: int32
          description: |
            Indicates the expiration year of the card.

            Example: 2032
          example: 2032
          nullable: false
        createdOn:
          type: string
          nullable: true
          description: >
            Indicates the date the customer was created (in an ISO 8601
            date-time UTC format).


            Examples: 2025-01-27T12:05:54.322587Z
          example: '2025-01-27T12:05:54.322587Z'
          format: date-time
        accountNumber:
          type: string
          description: |
            Specifies the account number.

            Example: 123456789
          example: '123456789'
          nullable: true
        routingNumber:
          minLength: 1
          type: string
          description: |
            Specifies the routing number.

            Example: 123123123
          example: '123123123'
        accountType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.AccountType'
        accountHolderType:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.AccountHolderType
        taxId:
          type: string
          description: |
            Specifies the customer's tax identifier (TIN).

            Example: 98-7654321
          example: 98-7654321
          nullable: true
        cardTokenType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.TokenType'
      additionalProperties: false
    Contracts.Page.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.GetCustomerPaymentMethods.GetCustomerPaymentMethodsResponse
          nullable: true
        total:
          type: integer
          description: |
            Indicates the total number of payment methods found.

            Example: 7
          example: 7
          format: int32
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Customers.PaymentMethods.Update.UpdatePaymentMethodRequest:
      type: object
      properties:
        name:
          type: string
          description: >
            Specifies the payment method name.


            This is a free-formed name that is convenient for the merchant to
            recognize.


            Example: Cafe Peppared
          example: Cafe Peppared
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceUserResponse:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the user identifier.

            Example: 04103b7f-c2fc-444b-b1ab-93eee3aec815
          example: 04103b7f-c2fc-444b-b1ab-93eee3aec815
          format: uuid
        firstName:
          type: string
          description: |
            Indicates the customer's first name.

            Example: Alexandro
          example: Alexandro
          nullable: true
        lastName:
          type: string
          description: |
            Indicates the customer's last name.

            Example: Peppared
          example: Peppared
          nullable: true
        email:
          type: string
          description: |
            Indicates the user's email address.

            Example: peppared@example.com
          example: peppared@example.com
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceResponse:
      type: object
      properties:
        deviceId:
          type: string
          format: uuid
          description: |
            Indicates the device identifier.

            Example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1451
          example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1451
          nullable: true
        deviceName:
          type: string
          description: |
            Indicates the device name.

            Example: iPhone12,1
          example: iPhone12,1
          nullable: true
        lastLoginAt:
          type: string
          format: date-time
          description: |
            Indicates the last login time (in an ISO 8601 date-time UTC format).

            Example: 2026-01-19T14:27:02.767105Z
          example: '2026-01-19T14:27:02.767105Z'
        apiKeyName:
          type: string
          description: |
            Indicates the API key name being used.

            Example: Peppared's Cafe Key
          example: Peppared's Cafe Key
          nullable: true
        tapToPayStatus:
          type: string
          description: |
            Indicates the tap to pay status.

            Valid values are:

            | Tap To Pay status |
            |-----------|
            | Active    |
            | Approved  |
            | Denied    |
            | Inactive  |
            | Requested |

            Example: Active
          example: Active
          nullable: true
        tapToPayStatusId:
          type: integer
          description: |
            Indicates the tap to pay status identifier.

            Valid values are:

            | Id | Status    |
            |----|-----------|
            | 0  | Inactive  |
            | 1  | Requested |
            | 2  | Approved  |
            | 3  | Active    |
            | 4  | Denied    |

            Example: 2
          example: 2
          format: int32
        tapToPayEnabled:
          type: boolean
          description: |
            Indicates tap to pay feature is enabled.

            If `true`, tap to pay feature is enabled.<br>
            If `false`, tap to pay feature is not enabled.

            Example: true
          example: true
        userProfiles:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceUserResponse
          description: Profiles associated with this device
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.GetDevicesResponse:
      type: object
      properties:
        devices:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Devices.Get.DeviceResponse
          description: Indicates a list of devices associated with the current merchant.
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Devices.CreateOrUpdate.CreateOrUpdateDeviceRequest:
      type: object
      properties:
        deviceId:
          type: string
          description: |
            Specifies the device identifier.

            Example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1452
          example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1452
          nullable: true
        deviceName:
          type: string
          description: |
            Specifies the device name.

            Example: iPhone12,1
          example: iPhone12,1
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Devices.CreateOrUpdate.CreateOrUpdateDeviceResponse:
      type: object
      properties:
        deviceId:
          type: string
          description: |
            Indicates the device identifier.

            Example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1452
          example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1452
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Devices.TapToPay.GenerateTapToPayJwtRequest:
      type: object
      properties:
        deviceId:
          type: string
          description: |
            Specifies the device identifier.

            Example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1453
          example: 7aafd09f-b3e6-43fb-b815-5db3bf7f1453
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Devices.TapToPay.GenerateTapToPayJwtResponse:
      type: object
      properties:
        jwtToken:
          type: string
          description: The generated JWT for Tap-to-Pay.
          nullable: true
        expiresAt:
          type: string
          format: date-time
          description: >
            Indicates the expiration date and time (in an ISO 8601 date-time UTC
            format) of the token.


            Example: 2026-01-19T14:27:02.767105Z
          example: '2026-01-19T14:27:02.767105Z'
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto.MerchantApiTokenDto:
      type: object
      properties:
        merchantId:
          type: string
          description: |
            Indicates the merchant identifier of the API key.

            Example: fae7620d-ab02-4375-bc20-6ff326b917fd
          example: fae7620d-ab02-4375-bc20-6ff326b917fd
          format: uuid
        tokenName:
          type: string
          description: >
            Indicates the name of the API key.


            This is a free-formed descriptive name to more easily identify the
            API key.


            Example: Peppared Street Cafe's API Key
          example: Peppared Street Cafe's API Key
          nullable: true
        clientId:
          type: string
          description: >
            The clientId or the first value association with the API key.


            This is the public portion of the API key.

            The second value association with the API key, the client secret, is
            never shown after the initial creation.


            Example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5
          example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5
          format: uuid
        creationDate:
          type: string
          description: >
            Specifies the creation date of the API key (in an ISO 8601 date-time
            UTC format).


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
          format: date-time
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto:
      type: object
      properties:
        tokens:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.GetMerchantApiTokensResponseDto.MerchantApiTokenDto
          description: >
            <br>Specifies an array of objects identifying a list API keys.

            These API keys were created for merchants under a partner account or
            as a standalone merchant.
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.CreateMerchantApiTokenRequestDto:
      required:
        - merchantId
        - tokenName
      type: object
      properties:
        merchantId:
          type: string
          description: |
            Specifies the identifier of the merchant.

            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          format: uuid
        tokenName:
          minLength: 1
          type: string
          description: |
            A free-formed descriptive name for the API key.

            Example: Peppared Street Cafe's API Key
          example: Peppared Street Cafe's API Key
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.MerchantApiTokens.CreateMerchantApiTokenResponseDto:
      type: object
      properties:
        clientId:
          type: string
          description: |
            Identifies the clientId associated with the API key.

            See `clientSecret` for the client secret.

            Example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5
          example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5
          format: uuid
        clientSecret:
          type: string
          description: |
            Identifies the client secret associated with the API key.

            This value is only shown once at the time of creation.
            Be sure to store it securely, as it cannot be retrieved again later.

            See `clientId` for the client identifier.
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Enums.SettlementBatchStatus:
      type: integer
      description: |
        Possible values:

        | Value | Name    |
        |-------|---------|
        | 1     | Open    |
        | 2     | Settled |

        Example: 2
      example: 2
      format: int32
    PaymentGateway.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        paymentProcessorId:
          type: string
          format: uuid
          description: |
            Indicates the payment processor identifier.

            Example: 2059fcc1-5507-42be-8e4c-f4fcce245027
          example: 2059fcc1-5507-42be-8e4c-f4fcce245027
        paymentProcessorName:
          type: string
          nullable: true
        externalBatchId:
          type: string
          nullable: true
        batchDateTime:
          type: string
          format: date-time
          nullable: true
          description: |
            Specifies the batch date time (in an ISO 8601 date-time UTC format).

            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        transactionCount:
          type: number
          format: double
        netAmount:
          type: number
          format: double
        refundsAmount:
          type: number
          format: double
        salesAmount:
          type: number
          format: double
        statusId:
          type: integer
          description: |-
            SettlementBatchStatus
            Open = 1
            Settled = 2
          format: int32
        statusName:
          type: string
          nullable: true
      additionalProperties: false
    Contracts.Page.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.SettlementBatches.GetPage.GetIsvSettlementBatchesResponse
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of settlement batches found.

            Example: 31
          example: 31
      additionalProperties: false
    PaymentGateway.Contracts.SourceResponseDto:
      type: object
      properties:
        typeId:
          type: integer
          format: int32
          nullable: true
        type:
          type: string
          nullable: true
        id:
          type: string
          format: uuid
          nullable: true
        name:
          type: string
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Amounts.SuggestedTipsDto:
      type: object
      properties:
        tipAmount:
          type: number
          format: double
          description: |
            Specifies the absolute amount (in USD) of the tip to be added.

            This amount adds to the base amount of the original transaction.
            That transaction must be authorized first.

            <span class="note">
            Values for `tipAmount` and `tipRate` are mutually exclusive.
            Care must be taken to include one or the other but not both.
            </span>

            Example: 14.50
          example: 14.5
        tipPercent:
          type: number
          description: >
            Specifies the tip rate as a percentage of the base amount to be
            added.


            This amount adds to the base amount of the original transaction.

            That transaction must be authorized first.


            <span class="note">

            Values for `tipAmount` and `tipRate` are mutually exclusive.

            Care must be taken to include one or the other but not both.

            </span>


            Example: 15 (as 15%)
          example: 15
          format: double
      additionalProperties: false
    PaymentGateway.Contracts.Transactions.GetPage.GetTransactionPageResponseDto.AvailableOperation:
      type: object
      properties:
        typeId:
          type: integer
          format: int32
        type:
          type: string
          nullable: true
        availableAmount:
          type: number
          format: double
          nullable: true
        suggestedTips:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Amounts.SuggestedTipsDto
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Amounts.AmountDto:
      type: object
      properties:
        baseAmount:
          type: number
          format: double
          description: >
            Identifies the original amount (in USD) of a transaction before
            adjustments are applied.


            Example: 129.99
          example: 129.99
        percentageOffAmount:
          type: number
          format: double
          description: >
            Identifies the discount amount (in USD) taken off.


            This discount was calculated using the preset percentage from
            `percentageOffRate`.


            Example: 12.50
          example: 12.5
        percentageOffRate:
          type: number
          format: double
          description: >
            Identifies the discount percentage.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `percentageOffAmount`.


            Example: 3.5 (as 3.5%)
          example: 3.5
        cashDiscountAmount:
          type: number
          format: double
          description: ''
        cashDiscountRate:
          type: number
          format: double
          description: >
            Identifies the discount percentage for a cash (or cash-equivalent)
            discount.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `cashDiscountAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        cashDiscountPercentage:
          type: number
          format: double
          description: >
            Identifies the discount percentage for a cash (or cash-equivalent)
            discount.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `cashDiscountAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        surchargeAmount:
          type: number
          format: double
          description: >
            Identifies the amount (in USD) when a surcharge is applicable.


            This is a surcharge on the base amount.

            This surcharge was calculated using the preset percentage from
            `surchargeRate`.


            Example: 6.45
          example: 6.45
        surchargeRate:
          type: number
          format: double
          description: >
            Identifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        tipAmount:
          type: number
          format: double
          description: |
            Specifies the absolute amount (in USD) of the tip to be added.

            This amount adds to the base amount of the original transaction.
            That transaction must be authorized first.

            <span class="note">
            Values for `tipAmount` and `tipRate` are mutually exclusive.
            Care must be taken to include one or the other but not both.
            </span>

            Example: 14.50
          example: 14.5
        tipRate:
          type: number
          format: double
          description: >
            Specifies the tip rate as a percentage of the base amount to be
            added.


            This amount adds to the base amount of the original transaction.

            That transaction must be authorized first.


            <span class="note">

            Values for `tipAmount` and `tipRate` are mutually exclusive.

            Care must be taken to include one or the other but not both.

            </span>


            Example: 15 (as 15%)
          example: 15
        taxAmount:
          type: number
          format: double
        taxRate:
          type: number
          format: double
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the transaction identifier.

            Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          format: uuid
        paymentProcessorId:
          type: string
          format: uuid
          description: |
            Indicates the payment processor identifier.

            Example: def7b3c4-5d6e-4f7a-8b9c-0d1e2f3a4b70
          example: def7b3c4-5d6e-4f7a-8b9c-0d1e2f3a4b70
        date:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            transaction date.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        baseAmount:
          type: number
          format: double
          nullable: true
          description: >
            Identifies the original amount (in USD) of the transaction before
            adjustments are applied.


            Example: 129.99
          example: 129.99
        totalAmount:
          type: number
          format: double
          nullable: true
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
        surchargeAmount:
          type: number
          format: double
          nullable: true
          description: >
            Identifies the amount (in USD) when a surcharge is applicable.


            This is a surcharge on the base amount.

            This surcharge was calculated using the preset percentage from
            `surchargePercentage`.


            Example: 6.45
          example: 6.45
        surchargePercentage:
          type: number
          format: double
          nullable: true
          description: >
            Identifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        currencyCode:
          type: string
          nullable: true
          description: |
            Indicates the currency (in ISO 4217 alpha-3 currency code format).

            Example: USD
          example: USD
        currencyId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
        merchant:
          type: string
          nullable: true
        merchantId:
          type: string
          format: uuid
          description: |
            Indicates the identifier of the merchant.

            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
        operationMode:
          type: string
          nullable: true
        paymentMethodType:
          type: string
          nullable: true
          description: |
            Indicates the payment method type name.

            Value values:

            | Name            | Id | Notes                    |
            |-----------------|:--:| ------------------------ |
            | Card            | 1  | For credit or debit card |
            | ElectronicCheck | 2  |                          |

            Example: Card
          example: Card
        paymentMethodTypeId:
          type: integer
          format: int32
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
        paymentMethodName:
          type: string
          nullable: true
          description: >
            Indicates the name of the payment method.


            This is a free-formed name that is convenient for the merchant to
            recognize.


            Example: Cafe Peppared
          example: Cafe Peppared
        customerName:
          type: string
          nullable: true
        customerCompany:
          type: string
          nullable: true
        customerPan:
          type: string
          nullable: true
          description: >
            Indicates customer’s PAN (primary account number).


            This is the payment card number.

            The value is masked except for a few numbers for additional
            security.


            Example: ************3655
          example: '************3655'
        cardTokenType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.TokenType'
        customerEmail:
          type: string
          nullable: true
        customerPhone:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Indicates the customer's phone number.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        status:
          type: string
          nullable: true
        statusId:
          type: integer
          format: int32
        typeId:
          type: integer
          format: int32
        type:
          type: string
          nullable: true
        batchId:
          type: string
          format: uuid
          nullable: true
        source:
          $ref: '#/components/schemas/PaymentGateway.Contracts.SourceResponseDto'
        availableOperations:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Transactions.GetPage.GetTransactionPageResponseDto.AvailableOperation
          nullable: true
        amount:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto'
      additionalProperties: false
    Contracts.Page.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.GetPage.GetIsvTransactionsResponse
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of ISV transactions found.

            Example: 5
          example: 5
      additionalProperties: false
    PaymentGateway.Contracts.Transactions.TransactionReceiptDto.AmountDto:
      type: object
      description: |
        Indicates an object detailing the amount.
      properties:
        baseAmount:
          type: number
          format: double
          description: >
            Identifies the original amount (in USD) of a transaction before
            adjustments are applied.


            Example: 129.99
          example: 129.99
        percentageOffAmount:
          type: number
          format: double
          description: >
            Identifies the discount amount (in USD) taken off.


            This discount was calculated using the preset percentage from
            `percentageOffRate`.


            Example: 12.50
          example: 12.5
        percentageOffRate:
          type: number
          format: double
          description: >
            Identifies the discount percentage.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `percentageOffAmount`.


            Example: 3.5 (as 3.5%)
          example: 3.5
        cashDiscountAmount:
          type: number
          format: double
          description: >
            Identifies the discount amount (in USD) when a cash (or
            cash-equivalent) discount is applied.


            This discount was calculated using the preset percentage from
            `cashDiscountRate`.


            Example: 10.55
          example: 10.55
        cashDiscountRate:
          type: number
          format: double
          description: >
            Identifies the discount percentage for a cash (or cash-equivalent)
            discount.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `cashDiscountAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        surchargeAmount:
          type: number
          format: double
          description: >
            Identifies the amount (in USD) when a surcharge is applicable.


            This is a surcharge on the base amount.

            This surcharge was calculated using the preset percentage from
            `surchargeRate`.


            Example: 6.45
          example: 6.45
        surchargeRate:
          type: number
          format: double
          description: >
            Identifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        tipAmount:
          type: number
          format: double
          description: |
            Specifies the absolute amount (in USD) of the tip to be added.

            This amount adds to the base amount of the original transaction.
            That transaction must be authorized first.

            <span class="note">
            Values for `tipAmount` and `tipRate` are mutually exclusive.
            Care must be taken to include one or the other but not both.<br><br>
            If neither value is provided, no tip is added.
            </span>

            Example: 14.50
          example: 14.5
        tipRate:
          type: number
          format: double
          description: >
            Specifies the tip rate as a percentage of the base amount to be
            added.


            This amount adds to the base amount of the original transaction.

            That transaction must be authorized first.


            <span class="note">

            Values for `tipAmount` and `tipRate` are mutually exclusive.

            Care must be taken to include one or the other but not both.<br><br>

            If neither value is provided, no tip is added.

            </span>


            Example: 15 (as 15%)
          example: 15
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
      additionalProperties: false
    PaymentGateway.Contracts.Enums.CardholderAuthenticationMethod:
      type: integer
      description: |
        Possible values:

        | Value | Name                        |
        |-------|-----------------------------|
        | 0     | NotAuthenticated            |
        | 1     | PIN                         |
        | 2     | ElectronicSignatureAnalysis |
        | 3     | ManualSignature             |
        | 4     | ManualOther                 |
        | 5     | Unknown                     |
        | 6     | SystematicOther             |
        | 7     | ETicketEnvAmex              |
        | 8     | OfflinePin                  |

        Example: 0
      example: 0
      format: int32
    PaymentGateway.Contracts.Enums.CardDataSource:
      type: integer
      format: int32
      description: >
        Specifies the card data source.


        Possible values:


        | Value  | Name              | Description                             
        |

        |:------:|-------------------|------------------------------------------|

        | 1      | Internet          | Virtual Terminal, ISV API               
        |

        | 2      | Swipe             | Track1, Track2                          
        |

        | 3      | NFC               | EMV Tags, Track2                        
        |

        | 4      | EMV               | EMV Tags                                
        |

        | 5      | EMVContactless    | EMV Tags                                
        |

        | 6      | FallbackSwipe     | Track 2                                 
        |

        | 7      | Manual            | Card present keyed transaction          
        |


        Example: 2
      example: 2
    PaymentGateway.Contracts.Transactions.TransactionReceiptDto.CardDetailsDto:
      type: object
      properties:
        authCode:
          type: string
          nullable: true
        mid:
          type: string
          nullable: true
          description: >
            Indicates the MID (merchant identifier) assigned to this
            transaction.


            Example: 43252511
          example: '43252511'
        tid:
          type: string
          nullable: true
          description: >
            Indicates the TID (terminal identifier) assigned to this
            transaction.


            Example: 8820432549239101
          example: '8820432549239101'
        cardCreditDebitTypeId:
          type: integer
          format: int32
        cardCreditDebitType:
          type: string
          nullable: true
        processCreditDebitTypeId:
          type: integer
          format: int32
        processCreditDebitType:
          type: string
          nullable: true
        rrn:
          type: string
          nullable: true
          description: >
            Indicates the RRN (retrieval reference number).


            This is a transaction tracking identifier used to specify and trace
            a transaction across systems.


            Example: 10628361287F
          example: 10628361287F
        cardTypeId:
          type: integer
          format: int32
        cardType:
          type: string
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Transactions.TransactionReceiptDto.ElectronicCheckDetails:
      type: object
      properties:
        customerAccountNumber:
          type: string
          nullable: true
        customerRoutingNumber:
          type: string
          nullable: true
        accountHolderType:
          type: string
          nullable: true
        accountHolderTypeId:
          type: integer
          format: int32
        accountType:
          type: string
          nullable: true
        accountTypeId:
          type: integer
          format: int32
        taxId:
          type: string
          nullable: true
          description: |
            Specifies the customer's TIN (tax identifier number).

            Example: 98-7654321
          example: 98-7654321
      additionalProperties: false
    PaymentGateway.Contracts.Enums.TransactionType:
      type: integer
      description: >
        Possible values:


        | Id | Type               | Description |

        |:--:|--------------------|-------------|

        | 1  | Authorization      |             |

        | 2  | Sale               |             |

        | 3  | Capture            |             |

        | 4  | Void               |             |

        | 5  | Refund             |             |

        | 6  | CardAuthentication |             |

        | 7  | RefundWORef        | Refund without reference.<br><br>As a
        warning, these are considered high-risk transaction types, as funds are
        debited directly from the merchant's account even if the original sale
        was not processed through Flute. |

        | 8  | TipAdjustment      |             |

        | 11 | AchDebit           |             |

        | 12 | AchRefund          |             |

        | 13 | AchHold            |             |

        | 14 | AchUnHold          |             |

        | 15 | AchCancel          |             |

        | 16 | AchCredit          |             |
      format: int32
    PaymentGateway.Contracts.Enums.TransactionOperation:
      type: object
      properties:
        typeId:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.TransactionType'
        type:
          type: string
          nullable: true
          readOnly: true
        availableAmount:
          type: number
          format: double
          nullable: true
        suggestedTips:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Amounts.SuggestedTipsDto
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Enums.AvsActions:
      type: integer
      description: |
        Possible values:

        | Value | Name  |
        |-------|-------|
        | 1     | Allow |
        | 2     | Deny  |

        Example: 1
      example: 1
      format: int32
    PaymentGateway.Contracts.Enums.AvsCodeGroupType:
      type: integer
      description: |
        Possible values:

        | Value | Name            |
        |-------|-----------------|
        | 1     | NoMatch         |
        | 2     | PartialMatch    |
        | 3     | Incompatible    |
        | 4     | Unavailable     |
        | 5     | ValidGroup      |

        Example: 5
      example: 5
      format: int32
    PaymentGateway.Contracts.Enums.AvsResponseResult:
      type: integer
      description: |
        Possible values:

        | Value | Name   |
        |-------|--------|
        | 1     | Passed |
        | 2     | Failed |

        Example: 1
      example: 1
      format: int32
    PaymentGateway.Contracts.Transactions.AvsResponseDto:
      type: object
      properties:
        actionId:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.AvsActions'
        action:
          type: string
          description: AVS Action
          nullable: true
          readOnly: true
        responseCode:
          type: string
          description: AVS Response Code
          nullable: true
        groupId:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.AvsCodeGroupType'
        group:
          type: string
          description: AVS Code Group
          nullable: true
          readOnly: true
        resultId:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.AvsResponseResult
        result:
          type: string
          description: >-
            AVS Response Result. Passed - all address data is correct. Failed -
            some address data is incorrect.
          nullable: true
          readOnly: true
        codeDescription:
          type: string
          description: AVS Response Code Description
          nullable: true
      additionalProperties: false
      description: Address Verification Service Response
    KeyValuePair`2:
      type: object
      properties:
        key:
          type: string
          nullable: true
        value:
          type: string
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Transactions.TransactionReceiptDto.EmvTagsDto:
      type: object
      properties:
        ac:
          type: string
          nullable: true
        tvr:
          type: string
          nullable: true
        tsi:
          type: string
          nullable: true
        aid:
          type: string
          nullable: true
        applicationLabel:
          type: string
          nullable: true
        rawTags:
          type: array
          items:
            $ref: '#/components/schemas/KeyValuePair`2'
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.TsysCardDetailsDto:
      type: object
      properties:
        authCode:
          type: string
          nullable: true
        mid:
          type: string
          nullable: true
          description: >
            Indicates the MID (merchant identifier) assigned to this
            transaction.


            Example: 43252511
          example: '43252511'
        tid:
          type: string
          nullable: true
          description: >
            Indicates the TID (terminal identifier) assigned to this
            transaction.


            Example: 8820432549239101
          example: '8820432549239101'
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.AchDetailsDto:
      type: object
      properties:
        customerAccountNumber:
          type: string
          nullable: true
        customerRoutingNumber:
          type: string
          nullable: true
        accountHolderType:
          type: string
          nullable: true
        accountHolderTypeId:
          type: integer
          format: int32
        accountType:
          type: string
          nullable: true
        accountTypeId:
          type: integer
          format: int32
        taxId:
          type: string
          nullable: true
          description: |
            Indicates the customer's TIN (tax identifier number).

            Example: 98-7654321
          example: 98-7654321
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse:
      type: object
      properties:
        transactionId:
          type: string
          format: uuid
          description: |
            Indicates the transaction identifier.

            Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
        transactionDateTime:
          type: string
          format: date-time
          description: >
            Indicates the date and time (in an ISO 8601 date-time UTC format) of
            the transaction execution.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        amount:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.AmountDto
        currencyId:
          type: integer
          format: int32
          description: |
            Indicates the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
        currency:
          type: string
          nullable: true
          description: |
            Indicates the currency code (in ISO 4217 currency code).

            Example: USD
          example: USD
        processorId:
          type: string
          format: uuid
          description: |
            Indicates the processor identifier.

            Example: f019d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
          example: f019d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d92
        processor:
          type: string
          nullable: true
          description: >
            Indicates the payment processor.


            This is the system or company that handles the actual movement and
            authorization of payment transactions.


            Examples:<br>

            TSYS<br>

            Fiserv
          example: TSYS
        operationTypeId:
          type: integer
          format: int32
          description: |
            Indicates the operation type value.

            Possible values:

            | Id | Operation Type |
            |:--:|----------------|
            | 1  | PayNow         |
            | 2  | Subscription   |

            example: 1
          example: 1
        operationType:
          type: string
          nullable: true
          description: |
            Indicates the operation type.

            Possible values:

            | Operation Type | Id |
            |----------------|:--:|
            | PayNow         | 1  |
            | Subscription   | 2  |

            Example: PayNow
          example: PayNow
        paymentMethodTypeId:
          type: integer
          format: int32
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
        paymentMethodType:
          type: string
          nullable: true
          description: |
            Indicates the payment method type name.

            Value values:

            | Name            | Id | Notes                    |
            |-----------------|:--:| ------------------------ |
            | Card            | 1  | For credit or debit card |
            | ElectronicCheck | 2  |                          |

            Example: Card
          example: Card
        transactionTypeId:
          type: integer
          format: int32
          description: |
            Indicates the transaction type identifier.

            Possible values:

            | Type          | Value |
            |---------------|:-----:|
            | Authorization | 1     |
            | Sale          | 2     |
            | Capture       | 3     |
            | Void          | 4     |
            | Refund        | 5     |
            | Verify        | 6     |

            Example: 5
          example: 5
        transactionType:
          type: string
          nullable: true
          description: |
            Indicates the transaction type name.

            Possible values:

            | Value         | Type  |
            |---------------|:-----:|
            | Authorization | 1     |
            | Sale          | 2     |
            | Capture       | 3     |
            | Void          | 4     |
            | Refund        | 5     |
            | Verify        | 6     |

            Example: Refund
          example: Refund
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        customerPan:
          type: string
          nullable: true
          description: >
            Indicates customer’s PAN (primary account number).


            This is the payment card number.

            The value is masked except for a few numbers for additional
            security.


            Example: ************3655
          example: '************3655'
        cardTokenType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.TokenType'
        statusId:
          type: integer
          format: int32
        status:
          type: string
          nullable: true
        merchantName:
          type: string
          nullable: true
        merchantAddress:
          type: string
          nullable: true
        merchantPhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Indicates the merchant's phone number.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        merchantEmailAddress:
          type: string
          nullable: true
        merchantWebsite:
          type: string
          nullable: true
        authCode:
          type: string
          nullable: true
        source:
          $ref: '#/components/schemas/PaymentGateway.Contracts.SourceResponseDto'
        cardholderAuthenticationMethodId:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.CardholderAuthenticationMethod
        cardholderAuthenticationMethod:
          type: string
          nullable: true
          readOnly: true
        cvmResultMsg:
          type: string
          nullable: true
        cardDataSourceId:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource'
        cardDataSource:
          type: string
          nullable: true
          readOnly: true
        responseCode:
          type: string
          nullable: true
        responseDescription:
          type: string
          nullable: true
        cardProcessingDetails:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.CardDetailsDto
        achProcessingDetails:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.ElectronicCheckDetails
        availableOperations:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Enums.TransactionOperation
          nullable: true
        avsResponse:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AvsResponseDto
        emvTags:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.EmvTagsDto
        orderNumber:
          type: string
          nullable: true
        baseAmount:
          type: number
          description: >
            Identifies the original amount (in USD) of a transaction before
            adjustments are applied.


            Deprecated. Use Amount.BaseAmount


            Example: 129.99
          example: 129.99
          format: double
          deprecated: true
        totalAmount:
          type: number
          description: Deprecated. Use Amount.TotalAmount
          format: double
          deprecated: true
        tsysCardDetails:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.TsysCardDetailsDto
        achDetails:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.Get.GetIsvTransactionResponse.AchDetailsDto
      additionalProperties: false
    PaymentGateway.Contracts.Enums.EMVFallbackCondition:
      type: integer
      description: |
        Possible values:

        | Value | Name              |
        |-------|-------------------|
        | 0     | ICCTerminalError  |
        | 1     | NoCandidateList   |

        Example: 2
      example: 2
      format: int32
    PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead:
      type: integer
      description: |
        Possible values:

        | Value | Name                  |
        |-------|-----------------------|
        | 0     | Successful            |
        | 1     | Failed                |
        | 2     | NotAChipTransaction   |
        | 3     | Unknown               |

        Example: 1
      example: 1
      format: int32
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL2Data:
      type: object
      properties:
        salesTaxRate:
          type: number
          description: >-
            Sales tax rate. Decimal Number. Max length=4. Allowed characters:
            0-9 .(dot) Allowed range: 0.01 - 100
          format: double
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.Transactions.TransactionProductDto:
      type: object
      properties:
        name:
          type: string
          description: >-
            The name of the product. Alphanumeric and special characters. Min
            Length=1, max length=50. Allowed special characters: Space, Slash /,
            Hyphen -, Comma
          nullable: true
        code:
          type: string
          nullable: true
          minLength: 0
          maxLength: 20
          description: |
            The merchant-assigned product identification code.

            The code may only contain letters, digits, spaces, and slashes.

            Example: SKU/24601
          example: SKU/24601
        unitPrice:
          type: number
          description: >-
            The product amount. Numeric. Max length=12. Allowed characters: 0-9
            .(dot)
          format: double
          nullable: true
        measurementUnit:
          type: string
          description: >-
            The unit of measurement for the product. Alphanumeric and special
            character Space. Max length=20
          nullable: true
        quantity:
          type: number
          description: The quantity of a product. Decimal number. Max length=12
          format: double
          nullable: true
        taxAmount:
          type: number
          description: >-
            The tax amount established on a product. Numeric. Max length=12.
            Allowed characters: 0-9 .(dot)
          format: double
          nullable: true
        discountRate:
          type: number
          description: >-
            The discount percentage applied to a product. Corresponds with
            productDiscountName. This does not impact transaction functionality.
            It is used for reporting purposes. Numeric. Max Length=4. Allowed
            range:0.01 to 100
          format: double
          nullable: true
        description:
          type: string
          description: >-
            The description of the product. Alphanumeric and special characters.
            Min length=1, max length=200.
          nullable: true
        measurementUnitId:
          type: integer
          description: MeasurementUnitId
          format: int32
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL3Data:
      type: object
      properties:
        invoiceNumber:
          type: string
          description: >-
            The Value Added Tax(VAT) invoice number associated with the
            transaction. Max length=15. Allowed characters: a-z A-Z 0-9 Space
          nullable: true
        purchaseOrder:
          type: string
          description: >-
            The value used by the customer to identify an order. Issued by the
            buyer to the seller. Max length=25. Allowed characters: a-z A-Z 0-9
            Space
          nullable: true
        shippingCharges:
          type: number
          description: >-
            The dollar amount for shipping or freight charges applied to a
            product or transaction. Numeric. Max length=12. Allowed characters:
            0-9 .(dot)
          format: double
          nullable: true
        dutyCharges:
          type: number
          description: >-
            Indicates the total charges for any import or export duties included
            in the order. Numeric. Max length=12. Allowed characters: 0-9 .(dot)
          format: double
          nullable: true
        products:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionProductDto
          description: Multiple products can be sent in a single request.
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationRequest:
      required:
        - amount
        - currencyId
        - expirationMonth
        - expirationYear
      type: object
      properties:
        amount:
          type: number
          format: double
          nullable: false
          description: |
            Specifies the amount of the transaction.

            Example: 29.99
          example: 29.99
        accountNumber:
          type: string
          nullable: false
          description: |
            Specifies the card number used for the transaction.

            This field may contain a token issued against a card number.
            This is de-tokenized by TransIT to process the transaction.

            Example: 4111111111111111
          example: '4111111111111111'
        currencyId:
          type: integer
          nullable: false
          description: |
            Specifies the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
          format: int32
        expirationMonth:
          type: integer
          nullable: false
          description: |
            Specifies the expiration month of the card.

            Example: 7
          example: 7
          format: int32
        expirationYear:
          type: integer
          nullable: false
          description: |
            Specifies the expiration year of the card.

            Example: 2032
          example: 2032
          format: int32
        paymentMethodId:
          type: string
          format: uuid
          nullable: true
          description: |
            Specifies the customer payment method identifier.

            We recommend using `paymentMethodId` instead of `accountNumber`.

            Example: b4c48037-4c5d-4e6f-7a8b-9c0d1e2f3a69
          example: b4c48037-4c5d-4e6f-7a8b-9c0d1e2f3a69
        cardDataSource:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource'
        deviceId:
          type: string
          format: uuid
          nullable: true
          description: |
            Specifies the device when using the Flute mobile app.

            If this value is included, the user is linked to that device.
            This stores their name as the transaction creator `createdBy`.

            Example: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
          example: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
        paymentProcessorId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the payment processor identifier.


            A list of available payment processers can be found with `GET
            {{baseURL}}/pay-api/v1/configurations/payments`.

            See response `availablePaymentProcessors.id`.<br>

            If omitted, the merchant's default payment processor will be used.


            Example: 37bd9ccb-2c9d-45cf-a65f-c9a224bdeaeb
          example: 37bd9ccb-2c9d-45cf-a65f-c9a224bdeaeb
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        tipAmount:
          type: number
          format: double
          nullable: true
          description: >
            Specifies the absolute amount (in USD) of the tip to be added.


            This amount adds to the number included in the field `amount`
            earlier.

            For example if `amount` is $100 and this `tipAmount` is $10, the
            authorize amount is $110.


            No additional tip amount or tip rate is required to be added, such
            as from `POST {{baseURL}}/pay-api/v1/transactions/tip-adjustment`


            <span class="note">

            Values for `tipAmount` and `tipRate` are mutually exclusive.

            Care must be taken to include one or the other but not both.

            </span>


            Example: 14.50
          example: 14.5
        tipRate:
          type: number
          format: double
          nullable: true
          description: >
            Specifies the tip rate as a percentage of the base amount to be
            added.


            This amount adds to the number included in the field `amount`
            earlier.

            For example if `amount` is $100 and this `tipRate` is `10`, the
            authorize amount is $110.


            No additional tip amount or tip rate is required to be added, such
            as from `POST {{baseURL}}/pay-api/v1/transactions/tip-adjustment`


            <span class="note">

            Values for `tipAmount` and `tipRate` are mutually exclusive.

            Care must be taken to include one or the other but not both.

            </span>


            Example: 15 (as 15%)
          example: 15
        percentageOffRate:
          type: number
          description: |
            The percent of the base amount to be discounted.

            Example:<br>
            8.25 (as 8.25%)<br>
            12 (as 12%)
          example: 12
          format: double
          nullable: true
        surchargeRate:
          type: number
          description: >
            The percent of transaction amount to be added to the amount after
            `percentageOffRate` is applied.


            Example:<br>

            8.25 (as 8.25%)<br>

            12 (as 12%)
          example: 12
          format: double
          nullable: true
        useCardPrice:
          type: boolean
          description: >
            Parameter is mandatory when merchant has ZeroCostProcessingOption ==
            Dual

            Pricing.


            Parameter must be null when merchant has other
            ZeroCostProcessingOption.


            For Dual Pricing, amount should be the card price and useCardPrice
            should

            be `true`, or amount should be the cash price and useCardPrice
            should be

            `false`.
          nullable: true
        appVersion:
          type: string
          nullable: true
          description: >
            Specifies the version of the mobile app.


            This value is stored on the transaction.

            It is visible in the transaction details.

            The `appVersion` value takes priority over the `sdkVersion` if both
            are present.


            Example: 10.413.01
          example: 10.413.01
        sdkVersion:
          type: string
          nullable: true
          description: >
            Specifies the version of the Flute SDK.


            This value is stored on the transaction.

            It is visible in the transaction details.

            The `appVersion` value takes priority over the `sdkVersion` if both
            are present.


            Example: 8.61.01
          example: 8.61.01
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        contactInfo:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto
        securityCode:
          type: string
          description: The three or four digit security code on the credit card.
          nullable: true
        track1:
          type: string
          description: The card data from track 1 of the magnetic stripe.
          nullable: true
        track2:
          type: string
          description: >-
            Information stored on the magnetic stripe of a credit or debit card,
            including the card number, expiration date, and cardholder's name.
          nullable: true
        emvTags:
          type: array
          items:
            type: string
          description: >-
            Each tag corresponds to a particular piece of data stored on the
            card.
          nullable: true
        emvPaymentAppVersion:
          type: string
          description: The version number of the payment application in use.
          nullable: true
        pin:
          type: string
          nullable: true
        pinKsn:
          type: string
          nullable: true
        emvFallbackCondition:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackCondition
        emvFallbackLastChipRead:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead
        referenceId:
          type: string
          description: >
            Specifies an external transaction identifier for client-side
            tracking.


            Also used in duplicate control validation.

            A unique value allows similar transactions to process as distinct,
            bypassing duplicate blocking when needed.
          nullable: true
        l2:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL2Data
        l3:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL3Data
        customerInitiatedTransaction:
          type: boolean
          description: |-
            Customer Initiated Transaction if true
            Merchant Initiated Transaction if false
            Default value - false.
      additionalProperties: false
    PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto:
      type: object
      properties:
        hostResponseCode:
          type: string
          description: >-
            A two-character response code indicating the status of the
            authorization request.
          nullable: true
        hostResponseMessage:
          type: string
          description: Authorization response message.
          nullable: true
        hostResponseDefinition:
          type: string
          description: Response definition
          nullable: true
        code:
          type: string
          description: High-level operation response - approve, decline or error.
          nullable: true
        message:
          type: string
          description: Free-form result description.
          nullable: true
        processorResponseCode:
          type: string
          description: >
            Processor-specific response code that precisely describes the
            operation result.
          nullable: true
        authCode:
          type: string
          description: The authorization code received for the transaction.
          nullable: true
        maskedPan:
          type: string
          nullable: true
          description: |
            Indicates the customer’s PAN (primary account number).

            This is the payment card number.
            The value is partially masked, or blocked, for security.

            Example: ********3743
          example: '********3743'
      additionalProperties: false
    PaymentGateway.Contracts.Transactions.TransactionReceiptDto:
      type: object
      nullable: true
      description: >
        <br>Indicates an object describing the transaction receipt.

        The transaction receipt will be null or empty before the transaction is
        completed.

        After the completed transaction, it will be filled out.
      properties:
        transactionId:
          type: string
          format: uuid
          description: |
            Identifies the transaction identifier.

            Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
        transactionDateTime:
          type: string
          format: date-time
          description: >
            Identifies the date-time (in an ISO 8601 date-time UTC format) of
            the transaction execution.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        amount:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.AmountDto
        currencyId:
          type: integer
          format: int32
          description: |
            Indicates the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
        currency:
          type: string
          nullable: true
          description: |
            Indicates the currency code (in ISO 4217 currency code).

            Example: USD
          example: USD
        processorId:
          type: string
          format: uuid
          description: |
            Indicates the processor identifier.

            Example: ef08c4d5-6e7f-4a8b-9c0d-1e2f3a4b5c81
          example: ef08c4d5-6e7f-4a8b-9c0d-1e2f3a4b5c81
        processor:
          type: string
          nullable: true
          description: >
            Indicates the payment processor.


            This is the system or company that handles the actual movement and
            authorization of payment transactions.


            Examples:<br>

            TSYS<br>

            Fiserv
          example: TSYS
        operationTypeId:
          type: integer
          format: int32
          description: |
            Indicates the operation type value.

            Possible values:

            | Id | Operation Type |
            |:--:|----------------|
            | 1  | PayNow         |
            | 2  | Subscription   |

            example: 1
          example: 1
        operationType:
          type: string
          nullable: true
          description: |
            Indicates the operation type.

            Possible values:

            | Operation Type | Id |
            |----------------|:--:|
            | PayNow         | 1  |
            | Subscription   | 2  |

            Example: PayNow
          example: PayNow
        paymentMethodTypeId:
          type: integer
          format: int32
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
        paymentMethodType:
          type: string
          nullable: true
          description: |
            Indicates the payment method type name.

            Value values:

            | Name            | Id | Notes                    |
            |-----------------|:--:| ------------------------ |
            | Card            | 1  | For credit or debit card |
            | ElectronicCheck | 2  |                          |

            Example: Card
          example: Card
        transactionTypeId:
          type: integer
          format: int32
          description: |
            Indicates the transaction type identifier.

            Possible values:

            | Type          | Value |
            |---------------|:-----:|
            | Authorization | 1     |
            | Sale          | 2     |
            | Capture       | 3     |
            | Void          | 4     |
            | Refund        | 5     |
            | Verify        | 6     |

            Example: 5
          example: 5
        transactionType:
          type: string
          nullable: true
          description: |
            Indicates the transaction type name.

            Possible values:

            | Value         | Type  |
            |---------------|:-----:|
            | Authorization | 1     |
            | Sale          | 2     |
            | Capture       | 3     |
            | Void          | 4     |
            | Refund        | 5     |
            | Verify        | 6     |

            Example: Refund
          example: Refund
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        customerPan:
          type: string
          nullable: true
          description: >
            Indicates customer’s PAN (primary account number).


            This is the payment card number.

            The value is masked except for a few numbers for additional
            security.


            Example: ************4512
          example: '************4512'
        cardTokenType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.TokenType'
        statusId:
          type: integer
          format: int32
        status:
          type: string
          nullable: true
        merchantName:
          type: string
          nullable: true
        merchantAddress:
          type: string
          nullable: true
        merchantPhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          nullable: true
          description: |
            Indicates the merchant's phone number.

            Example: +14155552309
          example: '+14155552309'
        merchantEmailAddress:
          type: string
          nullable: true
        merchantWebsite:
          type: string
          nullable: true
        authCode:
          type: string
          nullable: true
        source:
          $ref: '#/components/schemas/PaymentGateway.Contracts.SourceResponseDto'
        cardholderAuthenticationMethodId:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.CardholderAuthenticationMethod
        cardholderAuthenticationMethod:
          type: string
          nullable: true
          readOnly: true
        cvmResultMsg:
          type: string
          nullable: true
        cardDataSourceId:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource'
        cardDataSource:
          type: string
          nullable: true
          readOnly: true
        responseCode:
          type: string
          nullable: true
        responseDescription:
          type: string
          nullable: true
        cardProcessingDetails:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.CardDetailsDto
        achProcessingDetails:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.ElectronicCheckDetails
        availableOperations:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Enums.TransactionOperation
          nullable: true
        avsResponse:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AvsResponseDto
        emvTags:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto.EmvTagsDto
        orderNumber:
          type: string
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Authorization.IsvAuthorizationResponse:
      type: object
      properties:
        transactionId:
          type: string
          format: uuid
          description: |
            Identifies the transaction identifier.

            Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
        transactionDateTime:
          type: string
          format: date-time
          description: >
            Specifies the date and time (in an ISO 8601 date-time UTC format) of
            the transaction execution.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        typeId:
          type: integer
          description: Type id of transaction.
          format: int32
        type:
          type: string
          description: Type name of transaction
          nullable: true
        statusId:
          type: integer
          description: |
            Indicates the status identifier of the transaction.
          format: int32
        status:
          type: string
          description: |
            Indicates the status name of the transaction
          nullable: true
        details:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto
        transactionReceipt:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto
        processedAmount:
          type: number
          description: >-
            Indicates which amount is authorized. The amount may differ from the
            amount in the request.
          format: double
        avsResponse:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AvsResponseDto
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Sale.IsvSaleRequest:
      required:
        - amount
        - cardDataSource
        - currencyId
        - expirationMonth
        - expirationYear
      type: object
      properties:
        amount:
          type: number
          format: double
          description: |
            Specifies the amount of the transaction.

            Example: 64.99
          example: 64.99
        cardDataSource:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource'
        currencyId:
          type: integer
          description: |
            Specifies the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
          format: int32
        expirationMonth:
          type: integer
          description: |
            Specifies the expiration month of the card.

            Example: 7
          example: 7
          format: int32
          nullable: false
        expirationYear:
          type: integer
          format: int32
          description: |
            Specifies the expiration year of the card.

            Example: 2032
          example: 2032
          nullable: false
        deviceId:
          type: string
          format: uuid
          nullable: true
          description: |
            Specifies the device when using the Flute mobile app.

            If this value is included, the user is linked to that device.
            This stores their name as the transaction creator `createdBy`.

            Example: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
          example: a30f9b66-b2f0-4b18-a03a-b861b00afa8b
        paymentProcessorId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the payment processor identifier.


            A list of available payment processers can be found with `GET
            {{baseURL}}/pay-api/v1/configurations/payments`.

            See response `availablePaymentProcessors.id`.<br>

            If omitted, the merchant's default payment processor will be used.


            Example: 8ebb41c8-e1b0-4777-8f8e-1402e756ee7d
          example: 8ebb41c8-e1b0-4777-8f8e-1402e756ee7d
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        paymentMethodId:
          type: string
          description: |
            Specifies the customer payment method identifier.

            We recommend using `paymentMethodId` instead of `accountNumber`.

            Example: b4c48037-4c5d-4e6f-7a8b-9c0d1e2f3a69
          example: b4c48037-4c5d-4e6f-7a8b-9c0d1e2f3a69
          format: uuid
          nullable: true
        accountNumber:
          type: string
          nullable: false
          description: |
            Specifies the 13-19 digit card number used for the transaction.

            We recommend using `paymentMethodId` instead of `accountNumber`

            This field may contain a token issued against a card number.
            This is de-tokenized by TransIT to process the transaction.
        tipAmount:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the absolute amount (in USD) of the tip to be added.

            This amount adds to the base amount of the original transaction.
            That transaction must be authorized first.

            <span class="note">
            Values for `tipAmount` and `tipRate` are mutually exclusive.
            Care must be taken to include one or the other but not both.
            </span>

            Example: 14.50
          example: 14.5
        tipRate:
          type: number
          format: double
          nullable: true
          description: >
            Specifies the tip rate as a percentage of the base amount to be
            added.


            This amount adds to the base amount of the original transaction.

            That transaction must be authorized first.


            <span class="note">

            Values for `tipAmount` and `tipRate` are mutually exclusive.

            Care must be taken to include one or the other but not both.

            </span>


            Example: 15 (as 15%)
          example: 15
        percentageOffRate:
          type: number
          format: double
          nullable: true
          description: |
            Identifies the discount percentage.

            This value is percentage rate for the discount.

            Example: 3.5 (as 3.5%)
          example: 3.5
        surchargeRate:
          type: number
          format: double
          nullable: true
          description: >
            Identifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        useCardPrice:
          type: boolean
          description: >
            Parameter is mandatory when merchant has ZeroCostProcessingOption ==
            Dual Pricing.


            Parameter must be null when merchant has other
            ZeroCostProcessingOption.


            For Dual Pricing, amount should be the card price and useCardPrice
            should be `true`, or amount should be the cash price and
            useCardPrice should be `false'.
          nullable: true
        appVersion:
          type: string
          nullable: true
          description: >
            Specifies the version of the mobile app.


            This value is stored on the transaction.

            It is visible in the transaction details.

            The `appVersion` value takes priority over the `sdkVersion` if both
            are present.


            Example: 10.413.01
          example: 10.413.01
        sdkVersion:
          type: string
          nullable: true
          description: >
            Specifies the version of the Flute SDK.


            This value is stored on the transaction.

            It is visible in the transaction details.

            The `appVersion` value takes priority over the `sdkVersion` if both
            are present.


            Example: 8.61.08
          example: 8.61.08
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        contactInfo:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto
        securityCode:
          type: string
          nullable: true
          description: Specifies the three or four digit security code on the credit card.
        track1:
          type: string
          description: Specifies the card data from track 1 of the magnetic stripe.
          nullable: true
        track2:
          type: string
          description: >
            Information stored on the magnetic stripe of a credit or debit card.


            This includes the card number, expiration date, and cardholder's
            name.
          nullable: true
        emvTags:
          type: array
          items:
            type: string
          description: >-
            Each tag corresponds to a particular piece of data stored on the
            card.
          nullable: true
        emvPaymentAppVersion:
          type: string
          description: Specifies the version number of the payment application in use.
          nullable: true
        pin:
          type: string
          description: Specifies the encrypted PIN for the terminal.
          nullable: true
        pinKsn:
          type: string
          description: |
            Specifies the KSN for DUKPT PIN encryption.

            Required only if the PIN is encrypted using DUKPT.
          nullable: true
        debit:
          type: boolean
          description: >
            IF Debit THEN use card as a debit card, else use card as a credit
            card
          nullable: true
        emvFallbackCondition:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackCondition
        emvFallbackLastChipRead:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead
        referenceId:
          type: string
          description: >
            Specifies an external transaction identifier for client-side
            tracking.


            Also used in duplicate control validation.

            A unique value allows similar transactions to process as distinct,
            bypassing duplicate blocking when needed.
          nullable: true
        l2:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL2Data
        l3:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvL3Data
        customerInitiatedTransaction:
          type: boolean
          default: false
          description: |
            Customer Initiated Transaction if true.

            Merchant Initiated Transaction if false
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Capture.IsvCaptureRequest:
      required:
        - amount
        - transactionId
      type: object
      properties:
        amount:
          type: number
          description: >
            Specifies the base amount of the transaction before adjustments (if
            any).


            Adjustments, such as tips, discounts, and surcharges, are added
            individually through request parameters.

            The call makes all adjustments during processing.

            The total amount charged is returned in the response body
            `amount.totalAmount`.


            Example: 124.86
          example: 124.86
          format: double
        transactionId:
          type: string
          description: >
            Specifies the transactionId from the original authorization.


            After the transaction is complete, the transactionId is invalidated
            for future attempts.


            Example: 19be194d-d962-41e2-bba0-ee719ed94634
          example: 19be194d-d962-41e2-bba0-ee719ed94634
          format: uuid
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.IsvTransactionResponse:
      type: object
      properties:
        transactionId:
          type: string
          description: |
            Indicates the transaction identifier.

            Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          format: uuid
        transactionDateTime:
          type: string
          description: >
            Indicates the date and time (in ISO 8601 UTC or timezone offset
            format) of the transaction.


            Examples: 2026-08-24T08:45:22Z
          example: '2026-08-24T08:45:22Z'
          format: date-time
        typeId:
          type: integer
          description: Type id of transaction.
          format: int32
        type:
          type: string
          description: Type name of transaction
          nullable: true
        statusId:
          type: integer
          description: Status id of transaction.
          format: int32
        status:
          type: string
          description: Status name of transaction
          nullable: true
        details:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionResponseDetailsDto
        transactionReceipt:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Return.IsvReturnRequest:
      required:
        - cardDataSource
        - transactionId
      type: object
      properties:
        cardDataSource:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource'
        transactionId:
          type: string
          format: uuid
          description: |
            Specifies the transaction identifier.

            Example: 94c59697-3db4-4ef7-84f7-b1cc14f21d93
          example: 94c59697-3db4-4ef7-84f7-b1cc14f21d93
        track1:
          type: string
          description: The card data from track 1 of the magnetic stripe.
          nullable: true
        track2:
          type: string
          description: >-
            Information stored on the magnetic stripe of a credit or debit card,
            including the card number, expiration date, and cardholder's name.
          nullable: true
        emvTags:
          type: array
          items:
            type: string
          description: >-
            Each tag corresponds to a particular piece of data stored on the
            card.
          nullable: true
        emvPaymentAppVersion:
          type: string
          description: The version number of the payment application in use.
          nullable: true
        pin:
          type: string
          nullable: true
        pinKsn:
          type: string
          nullable: true
        amount:
          type: number
          description: Amount
          format: double
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Return.ReturnWORefRequest:
      required:
        - cardDataSource
        - currencyId
        - debit
        - paymentProcessorId
      type: object
      properties:
        cardDataSource:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.CardDataSource'
        currencyId:
          type: integer
          description: |
            Specifies the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
          format: int32
        debit:
          type: boolean
          description: |
            Specifies the card as a debit card.

            If `true`, the card as a debit card.<br>
            If `false`, the card as a credit card.

            Example: true
          example: true
        paymentProcessorId:
          type: string
          format: uuid
          description: >
            Specifies the identifier assigned to the payment processor.


            A list of available payment processers can be found with `GET
            {{baseURL}}/pay-api/v1/configurations/payments`.

            See response `availablePaymentProcessors.id`.


            Example: 0c16d6e5-6157-42f0-a285-d14abbc54faa
          example: 0c16d6e5-6157-42f0-a285-d14abbc54faa
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        amount:
          type: number
          description: The amount of the transaction.
          format: double
        accountNumber:
          type: string
          description: |
            The 13-19 digit card number used for the transaction.

            This field may contain a token issued against a card number.
            This is de-tokenized by TransIT to process the transaction.

            Example: 5413591081013511
            example: "5413591081013511"
          nullable: true
        securityCode:
          type: string
          description: The three or four digit security code on the credit card.
          nullable: true
        expirationMonth:
          type: integer
          format: int32
          nullable: true
          description: |
            Specifies the expiration month of the card.

            Example: 7
          example: 7
        expirationYear:
          type: integer
          format: int32
          nullable: true
          description: |
            Specifies the expiration year of the card.

            Example: 2032
          example: 2032
        track1:
          type: string
          description: Magnetic track 1.
          nullable: true
        track2:
          type: string
          description: Magnetic track 2.
          nullable: true
        emvTags:
          type: array
          items:
            type: string
          description: >-
            Holds data fetched from a EMV Chip Credit/Debit card to perform
            transaction.

            That is a string array of variable size, should be used as is.
          nullable: true
        emvPaymentAppVersion:
          type: string
          description: The version number of the payment application in use.
          nullable: true
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AddressDto
        contactInfo:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.ContactInfoDto
        pin:
          type: string
          description: Encrypted PIN for the terminal.
          nullable: true
        pinKsn:
          type: string
          description: |-
            The KSN for DUKPT PIN encryption.
            Required only if the PIN is encrypted using DUKPT.
          nullable: true
        emvFallbackCondition:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackCondition
        emvFallbackLastChipRead:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.EMVFallbackLastChipRead
        referenceId:
          type: string
          description: >
            Specifies an external transaction identifier for client-side
            tracking.


            Also used in duplicate control validation.

            A unique value allows similar transactions to process as distinct,
            bypassing duplicate blocking when needed.
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Settle.IsvSettleRequest:
      required:
        - paymentProcessorId
      type: object
      properties:
        paymentProcessorId:
          type: string
          format: uuid
          description: >
            Specifies the payment processor identifier.


            A list of available payment processers can be found with `GET
            {{baseURL}}/pay-api/v1/configurations/payments`.

            See response `availablePaymentProcessors.id`.


            Example: 8f5a4c27-71c4-4b5d-944e-8bb457594d86
          example: 8f5a4c27-71c4-4b5d-944e-8bb457594d86
      additionalProperties: false
    PaymentGateway.Contracts.Enums.ResponseCode:
      type: integer
      description: >
        A vendor independent response code.


        Valid values are:


        | Value | Name    |
        Description                                                                
        |

        |-------|---------|------------------------------------------------------------------------------|

        | 0     | Approve | Operation fully or partially
        approved.                                       |

        | 1     | Decline | Operation
        declined.                                                          |

        | 2     | Error   | Something prevents to complete the operation.
        Request format is wrong, or system error, or any other reason that
        prevented normal processing. |


        Example: 0
      example: 0
      format: int32
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Settle.IsvSettleResponse:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.ResponseCode'
        message:
          type: string
          description: Free-form result description.
          nullable: true
        processorResponseCode:
          type: string
          description: >-
            Processor-specific response code that precisely describes the
            operation result.
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.Void.IsvVoidRequest:
      required:
        - transactionId
      type: object
      properties:
        transactionId:
          type: string
          format: uuid
          description: |
            Specifies the transaction identifier.

            Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.TipAdjustment.TipAdjustmentRequest:
      type: object
      required:
        - transactionId
        - tipAmount
      properties:
        transactionId:
          type: string
          description: |
            Specifies the transaction identifier.

            Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          format: uuid
        tipAmount:
          type: number
          format: double
          description: |
            Specifies the absolute amount (in USD) of the tip to be added.

            This amount adds to the base amount of the original transaction.
            That transaction must be authorized first.

            Example: 14.50
          example: 14.5
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.Transactions.SendReceiptBySms.SendIsvTransactionReceiptBySmsRequest:
      required:
        - customerConsent
        - phoneNumber
      type: object
      properties:
        phoneNumber:
          minLength: 1
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Identifies the customer's phone number.

            Example: +15551234567
          example: '+15551234567'
        customerConsent:
          type: boolean
          description: |
            Identifies the customer has consented to receiving the SMS.

            If `true`, the customer has consented to receiving the SMS.<br>
            If `false`, the customer has not consented to receiving the SMS.

            Example: true
          example: true
      additionalProperties: false
    PaymentGateway.Contracts.Enums.Currency:
      type: integer
      description: |
        Possible values:

        | Value | Name |
        |-------|------|
        | 1     | USD  |

        Example: 1
      example: 1
      format: int32
    PaymentGateway.Contracts.PublicApi.Isv.Amounts.IsvAmountsResponse:
      type: object
      properties:
        currencyId:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.Currency'
        currency:
          type: string
          nullable: true
          readOnly: true
          description: |
            Indicates the currency code (in ISO 4217 currency code).

            Example: USD
          example: USD
        zeroCostProcessingOptionId:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Enums.ZeroCostProcessingOption
        zeroCostProcessingOption:
          type: string
          nullable: true
          readOnly: true
          description: |
            Zero Cost Processing Option name.

            Possible values:

            | Type         | Id |
            |--------------|:--:|
            | None         | 1  |
            | CashDiscount | 2  |
            | DualPricing  | 3  |
            | Surcharge    | 4  |

            Example: DualPricing
          example: DualPricing
        useCardPrice:
          type: boolean
          nullable: true
        cash:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto'
        creditCard:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto'
        debitCard:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto'
        ach:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto'
      additionalProperties: false
    PaymentGateway.Contracts.TransactionSettings.L2Settings:
      type: object
      properties:
        taxRate:
          type: number
          format: double
          nullable: true
          description: |
            Identifies the type of tax rate.

            This field is used if `taxCategory` is not used.

            Default sale tax rate in percentage.
            Must be between 0% - 22%, applicable only Level 2 AutoFill.
      additionalProperties: false
    PaymentGateway.Contracts.TransactionSettings.Product:
      type: object
      properties:
        name:
          type: string
          description: The name of the product.
          nullable: true
        code:
          type: string
          nullable: true
          description: |
            The merchant-assigned product identification code.

            The code may only contain letters, digits, spaces, and slashes.

            Example: SKU/24601
          example: SKU/24601
        unitPrice:
          type: number
          description: The unit price for the product.
          format: double
          nullable: true
        measurementUnit:
          type: string
          description: The unit of measurement for the product.
          nullable: true
        quantity:
          type: number
          description: Quantity of the product.
          format: double
          nullable: true
        discountPercentage:
          type: number
          description: |
            Indicates the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
          format: double
          nullable: true
        description:
          type: string
          description: Product description
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.TransactionSettings.L3Settings:
      type: object
      properties:
        product:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.TransactionSettings.Product
        shippingCharge:
          type: number
          description: >-
            The percentage for shipping or freight charges applied to a product
            or transaction.
          format: double
          nullable: true
        dutyChargeRate:
          type: number
          description: >-
            Indicates the percentage for any import or export duties included in
            the order.
          format: double
          nullable: true
      additionalProperties: false
    PaymentGateway.Contracts.TransactionSettings.GetAutofillSettingsResponseDto:
      type: object
      properties:
        l2Settings:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.TransactionSettings.L2Settings
        l3Settings:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.TransactionSettings.L3Settings
      additionalProperties: false
    PaymentGateway.Contracts.PublicApi.Isv.TransactionSettings.CreateAutofillSettingsRequest:
      required:
        - l2Settings
        - l3Settings
      type: object
      properties:
        l2Settings:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.TransactionSettings.L2Settings
        l3Settings:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.TransactionSettings.L3Settings
      additionalProperties: false
    SubscriptionsService.Contracts.Subscriptions.PaymentAmountDto:
      type: object
      properties:
        baseAmount:
          type: number
          format: double
          description: >
            Identifies the original amount (in USD) of a transaction before
            adjustments are applied.


            Example: 129.99
          example: 129.99
        percentageOffAmount:
          type: number
          format: double
          description: >
            Identifies the discount amount (in USD) taken off.


            This discount was calculated using the preset percentage from
            `percentageOffRate`.


            Example: 12.50
          example: 12.5
        percentageOffRate:
          type: number
          format: double
          description: >
            Identifies the discount percentage.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `percentageOffAmount`.


            Example: 3.5 (as 3.5%)
          example: 3.5
        cashDiscountAmount:
          type: number
          format: double
          description: >
            Identifies the discount amount (in USD) when a cash (or
            cash-equivalent) discount is applied.


            This discount was calculated using the preset percentage from
            `cashDiscountRate`.


            Example: 10.55
          example: 10.55
        cashDiscountRate:
          type: number
          format: double
          description: >
            Identifies the discount percentage for a cash (or cash-equivalent)
            discount.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `cashDiscountAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        surchargeAmount:
          type: number
          format: double
          description: >
            Identifies the amount (in USD) when a surcharge is applicable.


            This is a surcharge on the base amount.

            This surcharge was calculated using the preset percentage from
            `surchargeRate`.


            Example: 6.45
          example: 6.45
        surchargeRate:
          type: number
          format: double
          description: >
            Identifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
      additionalProperties: false
    SubscriptionsService.Contracts.Enums.PaymentFrequencyUnit:
      type: integer
      format: int32
      description: >
        Indicates the payment frequency unit.


        As examples:<br>

        With a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of
        `1`, payments are made once a week.<br>

        With a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of
        `2`, payments are made twice a week


        Possible values:


        | ID | Label   |

        |:--:|---------|

        | 1  | Daily   |

        | 2  | Weekly  |

        | 3  | Monthly |


        Example: 3
      example: 3
    SubscriptionsService.Contracts.Subscriptions.Get.GetSubscriptionResponseDto.CustomerDto:
      type: object
      description: |
        <br>Indicates an object for returning subscription details.
      properties:
        customerName:
          type: string
          description: |
            Indicates the customer's full name.

            Example: Alexandro Peppared
          example: Alexandro Peppard
          nullable: true
        companyName:
          type: string
          description: |
            Indicates the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: 'Example: Peppared Street Cafe'
          nullable: true
        panMask:
          type: string
          description: >
            Indicates the masked PAN (primary account number).


            This is a partially obscured representation of a card's PAN.

            This value can be safely displayed to clients without revealing the
            actual or full account number.


            Examples:<br>

            4111********1234<br>

            ************1234<br>

            ****1234
          example: 4111********1234
          nullable: true
        cardTokenType:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Enums.TokenType'
        emailAddress:
          type: string
          description: |
            Indicates the customer's email contact.

            Example: peppared@example.com
          example: peppared@example.com
          nullable: true
        phoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          nullable: true
          description: |
            Indicates the customer's telephone number.

            Example: +15551234567
          example: '+15551234567'
      additionalProperties: false
    SubscriptionsService.Contracts.SourceResponseDto:
      type: object
      properties:
        typeId:
          type: integer
          format: int32
          nullable: true
        type:
          type: string
          nullable: true
        id:
          type: string
          format: uuid
          nullable: true
        name:
          type: string
          nullable: true
      additionalProperties: false
    SubscriptionsService.Contracts.InternalApi.Subscriptions.Get.GetSubscriptionResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: |
            Indicates the subscription identifier.

            Example: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14
          example: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14
        merchantId:
          type: string
          format: uuid
          description: |
            Indicates the merchant identifier.

            Example: 46f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a25
          example: 46f7a8b9-0c1d-4e2f-3a4b-5c6d7e8f9a25
        paymentProcessorId:
          type: string
          format: uuid
          description: |
            Indicates the payment processor identifier.

            Example: 57a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b36
          example: 57a8b9c0-1d2e-4f3a-4b5c-6d7e8f9a0b36
        statusId:
          type: integer
          format: int32
          description: |
            Indicates the subscription status identifier.

            Possible values:

            | Value | Meaning    |
            |:-----:|------------|
            | 1     | Active     |
            | 2     | Completed  |
            | 3     | Suspended  |
            | 4     | Delinquent |
            | 5     | Terminated |
            | 6     | Deleted    |

            Example: 2
          example: 2
        status:
          type: string
          nullable: true
          description: |
            Indicates the subscription status.

            Possible values:
            | Value      | Meaning |
            |------------|:----------:|
            | Active     | 1 |
            | Completed  | 2 |
            | Suspended  | 3 |
            | Delinquent | 4 |
            | Terminated | 5 |
            | Deleted    | 6 |

            Example: Completed
          example: Completed
        transactionTypeId:
          type: integer
          format: int32
          description: >
            Indicates the <a href="#flute-transaction-types">Flute transaction
            type identifier code</a> value.


            Example: 6
          example: 6
        transactionType:
          type: string
          description: |
            Indicates the transaction type name.

            Possible values:

            | Value         | Type  |
            |---------------|:-----:|
            | Authorization | 1     |
            | Sale          | 2     |
            | Capture       | 3     |
            | Void          | 4     |
            | Refund        | 5     |
            | Verify        | 6     |

            Example: Refund
          example: Refund
          nullable: true
        customerId:
          type: string
          format: uuid
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        paymentMethodId:
          $ref: '#/components/schemas/ach_paymentmethodid'
        paymentAmount:
          $ref: >-
            #/components/schemas/SubscriptionsService.Contracts.Subscriptions.PaymentAmountDto
        alreadyPaidAmount:
          type: number
          format: double
          description: >
            Indicates the total amount the client has already paid as part of
            this subscription.


            Example: 259.99
          example: 259.99
        allPaymentsAmount:
          type: number
          format: double
          description: |
            Indicates the total of all amounts due of the subscription.

            Example: 54.92
          example: 54.92
        currencyId:
          type: integer
          format: int32
          description: |
            Indicates the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
        paymentFrequencyUnitId:
          type: integer
          description: |
            Indicates the payment frequency identifier.

            Possible values:

            | ID | Label   |
            |:--:|---------|
            | 1  | Daily   |
            | 2  | Weekly  |
            | 3  | Monthly |

            Example: 3
          example: 3
          format: int32
        paymentFrequencyUnit:
          allOf:
            - $ref: >-
                #/components/schemas/SubscriptionsService.Contracts.Enums.PaymentFrequencyUnit
          nullable: true
        paymentFrequency:
          type: integer
          format: int32
          description: >
            Indicates the payment frequency identifier.


            Possible values:


            | Value   | Meaning |

            |---------|:--:|

            | Daily   | 1 |

            | Weekly  | 2 |

            | Monthly | 3 |


            As examples:<br>

            With a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of
            `1`, payments are made once a week.<br>

            With a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of
            `2`, payments are made twice a week.


            Example: Weekly
          example: Weekly
        createdOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) when
            the subscription was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        subscriptionStartDate:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            subscription's first payment.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        subscriptionEndDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            subscription's last payment.


            Examples: 2027-02-19T20:24:52.934Z
          example: '2027-02-19T20:24:52.934Z'
        lastPaymentDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            subscription's last payment date.


            Examples: 2027-02-19T20:24:52.934Z
          example: '2027-02-19T20:24:52.934Z'
        nextPaymentDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            subscription's next payment date.


            Examples: 2026-03-19T20:24:52.934Z
          example: '2026-03-19T20:24:52.934Z'
        successfulPaymentsCount:
          type: integer
          description: |
            Indicates the number of successful payments for the subscription.

            See `numberOfPayments` for the total expected number of payments.

            Example: 32
          example: 32
          format: int32
        numberOfPayments:
          type: integer
          description: |
            Total number of payments for the subscription.

            See `successfulPaymentsCount` for the current number of payments.

            Example: 60
          example: 60
          format: int32
        customer:
          $ref: >-
            #/components/schemas/SubscriptionsService.Contracts.Subscriptions.Get.GetSubscriptionResponseDto.CustomerDto
        source:
          $ref: >-
            #/components/schemas/SubscriptionsService.Contracts.SourceResponseDto
      additionalProperties: false
    SubscriptionsService.Contracts.Enums.TransactionType:
      type: integer
      description: >
        Specifies the transaction type.


        Possible values:


        | Id | Type          | Notes |

        |:--:|---------------| ----- |

        | 1  | Authorization | |

        | 2  | Sale          | The field `secCode` must also be omitted or set
        to null. |

        | 11 | AchDebit      | The field `secCode` must also be set to a valid
        value. |


        Example: 11
      example: 11
      format: int32
    SubscriptionsService.Contracts.Subscriptions.Create.CreateSubscriptionRequestDto:
      type: object
      required:
        - amount
        - currencyId
        - paymentProcessorId
        - transactionType
        - paymentFrequencyUnit
        - paymentFrequency
        - numberOfPayments
        - customerId
        - paymentMethodId
        - isFasterProcessing
      properties:
        amount:
          type: number
          description: |
            Specifies the total amount due (in USD) of the transaction.

            Example: 43.99
          example: 43.99
          format: double
        transactionType:
          $ref: >-
            #/components/schemas/SubscriptionsService.Contracts.Enums.TransactionType
        currencyId:
          type: integer
          format: int32
          description: |
            Specifies the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
        paymentProcessorId:
          type: string
          format: uuid
          description: |
            Specifies the payment processor identifier.

            Example: 8ebb41c8-e1b0-4777-8f8e-1402e756ee7d
          example: 8ebb41c8-e1b0-4777-8f8e-1402e756ee7d
        paymentMethodId:
          type: string
          description: |
            Specifies the payment method identifier.

            Must be added and active before subscription creation.

            Example: 7ef038b0-d612-4d10-9e2c-80e791b54632
            example: "7ef038b0-d612-4d10-9e2c-80e791b54632"
          format: uuid
        paymentFrequencyUnit:
          $ref: >-
            #/components/schemas/SubscriptionsService.Contracts.Enums.PaymentFrequencyUnit
        paymentFrequency:
          type: integer
          description: >
            Specifies the frequency of the payment value.


            As examples:<br>

            With a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of
            `1`, payments are made once a week.<br>

            With a `paymentFrequencyUnit` of `Weekly`, and `paymentFrequency` of
            `2`, payments are made twice a week.


            Example: 2
          example: 2
          format: int32
        numberOfPayments:
          type: integer
          format: int32
          description: |
            Specifies the number of payments for the subscription.

            Example: 60
          example: 60
        customerId:
          type: string
          description: |
            Specifies the customer identifier of the subscription.

            Example: d368cf28-4390-4f6d-b363-ce8d112e8517
          example: d368cf28-4390-4f6d-b363-ce8d112e8517
          format: uuid
        isFasterProcessing:
          $ref: '#/components/schemas/ach_isfasterprocessing'
        useCardPrice:
          type: boolean
          nullable: false
          description: >
            Specifies appling the card-based pricing instead of the cash-based
            pricing.


            The card price is typically higher because of processing fees.

            This fee is embedded in the price and not added as a line item.


            If `true`, use card-based pricing.<br>

            If `false`, use cash-based pricing.


            <span class="note">

            This value is required when the merchant `ZeroCostProcessingOption`
            is `DualPricing`.

            </span>


            <br><span class="note">

            This value must be null when the merchant `ZeroCostProcessingOption`
            is other than `DualPricing`.

            </span>


            Example: true
          example: true
        secCode:
          type: integer
          description: >
            <br>Specifies the SEC (standard entry class) code for the payment
            method.


            <span class="note">
              This value is required if `transactionType` is 11 (AchDebit).<br>
            </span>


            <br><span class="note">
              This value must be omitted or null if `transactionType` is 2 (Sale).
            </span>


            Allowed values:


            | secCode ID | Entry Type | Description |

            | :--------: |------------|-------------|

            | 1          | Web        | Internet-initiated/mobile entries.      
            |

            | 2          | PPD        | Prearranged payment and deposit entries.
            |

            | 3          | CCD        | Corporate credit or debit.              
            |

            | 4          | Telephone  | Telephone-initiated entries.            
            |


            Example: 1
          example: 1
          format: int32
          default: 1
        percentageOffRate:
          type: number
          description: |
            Specifies the percent of the base amount to be discounted.

            Example:<br>
            8.25 (as 8.25%)<br>
            12 (as 12%)
          example: 12
          format: double
          nullable: true
        surchargeRate:
          type: number
          description: >
            Specifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
          format: double
          nullable: true
        paymentStartDateTime:
          type: string
          format: date-time
          nullable: true
          description: >
            Specifies the date-time (in an ISO 8601 date-time UTC format) of the
            subscription's first payment date.


            If omitted or null, it indicates immediate payment(PayNow).


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
      additionalProperties: false
    SubscriptionsService.Contracts.Subscriptions.Create.CreateSubscriptionResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Subscription Id
          format: uuid
        payNowSuccess:
          type: boolean
          description: True if PayNow was executed successfully, otherwise false.
          nullable: true
        transactionId:
          type: string
          description: Transaction Id if PayNowSuccess was True.
          format: uuid
          nullable: true
        payNowResponse:
          type: string
          description: Payment response if PayNowSucess was False.
          nullable: true
      additionalProperties: false
    SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentAttemptResponseDto:
      type: object
      description: ''
      properties:
        id:
          type: string
          format: uuid
          description: |
            Indicates the subscription identifier.

            Example: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14
          example: 35e6f7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14
        executionDateTime:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            subscription's execution.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        statusId:
          type: integer
          format: int32
          description: |
            Indicates the subscription status identifier.

            Possible values:

            | Value | Meaning    |
            |:-----:|------------|
            | 1     | Active     |
            | 2     | Completed  |
            | 3     | Suspended  |
            | 4     | Delinquent |
            | 5     | Terminated |
            | 6     | Deleted    |

            Example: 2
          example: 2
        status:
          type: string
          nullable: true
          description: |
            Indicates the subscription status.

            Possible values:
            | Value      | Meaning |
            |------------|:----------:|
            | Active     | 1 |
            | Completed  | 2 |
            | Suspended  | 3 |
            | Delinquent | 4 |
            | Terminated | 5 |
            | Deleted    | 6 |

            Example: Completed
          example: Completed
        transactionStatusId:
          type: integer
          format: int32
          nullable: true
        transactionStatus:
          type: string
          nullable: true
        transactionId:
          type: string
          format: uuid
          nullable: true
      additionalProperties: false
    SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentsResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: |
            Indicates the subscription identifier.

            Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58
        initialExecutionDateTime:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            subscription's initial execution.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        statusId:
          type: integer
          format: int32
          description: |
            Indicates the subscription status identifier.

            Possible values:

            | Value | Meaning    |
            |:-----:|------------|
            | 1     | Active     |
            | 2     | Completed  |
            | 3     | Suspended  |
            | 4     | Delinquent |
            | 5     | Terminated |
            | 6     | Deleted    |

            Example: 2
          example: 2
        status:
          type: string
          nullable: true
          description: |
            Indicates the subscription status.

            Possible values:
            | Value      | Meaning |
            |------------|:----------:|
            | Active     | 1 |
            | Completed  | 2 |
            | Suspended  | 3 |
            | Delinquent | 4 |
            | Terminated | 5 |
            | Deleted    | 6 |

            Example: Completed
          example: Completed
        amount:
          type: number
          format: double
          description: |
            Indicates the payment amount.

            Example: 129.99
          example: 129.99
        paymentOrder:
          type: integer
          format: int32
          description: |
            Indicates a payment attempt identifier.

            Example: 748411
          example: 748411
        attempts:
          type: array
          description: |
            <br>Indicates the history of attempting to complete this order.
          items:
            $ref: >-
              #/components/schemas/SubscriptionsService.Contracts.Subscriptions.Isv.GetSubscriptionPayments.GetIsvSubscriptionPaymentAttemptResponseDto
          nullable: true
      additionalProperties: false
    SubscriptionsService.Contracts.InternalApi.Subscriptions.Terminate.TerminateSubscriptionResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: |
            Indicates the subscription identifier.

            Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58
        statusId:
          type: integer
          format: int32
          description: |
            Indicates the subscription status identifier.

            Possible values:

            | Value | Meaning    |
            |:-----:|------------|
            | 1     | Active     |
            | 2     | Completed  |
            | 3     | Suspended  |
            | 4     | Delinquent |
            | 5     | Terminated |
            | 6     | Deleted    |

            Example: 2
          example: 2
        status:
          type: string
          nullable: true
          description: |
            Indicates the subscription status.

            Possible values:
            | Value      | Meaning |
            |------------|:----------:|
            | Active     | 1 |
            | Completed  | 2 |
            | Suspended  | 3 |
            | Delinquent | 4 |
            | Terminated | 5 |
            | Deleted    | 6 |

            Example: Completed
          example: Completed
        message:
          type: string
          nullable: true
          description: >
            Indicates a message with additional details.


            Example: Subscription is terminated. Future payments will no longer
            be processed. This action is permanent.
          example: >-
            Subscription is terminated. Future payments will no longer be
            processed. This action is permanent
      additionalProperties: false
    PosService.Contracts.PosTransactionStatus:
      type: integer
      description: |
        Indicates the value of the status identifier.

        Possible values:

        | Value | Name                       |
        |:-----:|----------------------------|
        | 1     | TerminalConnecting         |
        | 2     | TransactionProcessing      |
        | 3     | DeclinedByProcessor        |
        | 4     | CancelByPos                |
        | 5     | CancelByTerminal           |
        | 6     | Completed                  |
        | 7     | Error                      |
        | 8     | Inconsistency              |
        | 9     | TerminalOffline            |
        | 10    | TransactionSentToProcessor |

        Example: 2
      example: 2
      format: int32
    PosService.Contracts.TransactionType:
      type: integer
      description: >
        Set the transaction type to be processed by the terminal.


        Possible values:


        | Id | Type               | Remarks |

        |:--:|--------------------|---------|

        | 1  | Authorization      | |

        | 2  | Sale               | |

        | 3  | Capture            | |

        | 4  | Void               | |

        | 5  | Refund             | |

        | 6  | CardAuthentication | |

        | 7  | RefundWORef        | Refund without reference.<br><br>As a
        warning, these are considered high-risk transaction types, as funds are
        debited directly from the merchant's account even if the original sale
        was not processed through Flute. |

        | 8  | TipAdjustment      | |

        | 10 | Settle             | |


        Example: 10
      example: 10
      format: int32
    PosService.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto:
      type: object
      properties:
        id:
          type: string
          description: |
            Indicates the POS transaction identifier.

            Example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7
          example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7
          format: uuid
        createdOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) the
            POS transaction was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        terminalId:
          type: string
          description: ID of terminal should handle POS Transaction
          format: uuid
        posTransactionStatusId:
          $ref: '#/components/schemas/PosService.Contracts.PosTransactionStatus'
        posTransactionStatus:
          type: string
          description: |
            Indicates the status identifier.

            Possible values:

            | Name                       | Value |
            |----------------------------|:-----:|
            | TerminalConnecting         | 1     |
            | TransactionProcessing      | 2     |
            | DeclinedByProcessor        | 3     |
            | CancelByPos                | 4     |
            | CancelByTerminal           | 5     |
            | Completed                  | 6     |
            | Error                      | 7     |
            | Inconsistency              | 8     |
            | TerminalOffline            | 9     |
            | TransactionSentToProcessor | 10    |

            Example: TransactionProcessing
          example: TransactionProcessing
          nullable: true
          readOnly: true
        transactionId:
          type: string
          description: ID of attached transaction. Available after processing.
          format: uuid
          nullable: true
        amount:
          type: number
          description: Transaction amount for transaction types requires Amount
          format: double
          nullable: true
        currencyId:
          type: integer
          description: |
            Indicates the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
          format: int32
          nullable: true
        targetTransactionId:
          type: string
          description: Transaction Id for Void, Capture, Refund
          format: uuid
          nullable: true
        transactionTypeId:
          $ref: '#/components/schemas/PosService.Contracts.TransactionType'
        transactionType:
          type: string
          nullable: true
          readOnly: true
          description: |
            Indicates the transaction type being processed by the terminal.

            Possible values:

            | Id            | Type |
            |---------------|:--:|
            | Authorization | 1 |
            | Sale          | 2 |
            | Capture       | 3 |
            | Void          | 4 |
            | Refund        | 5 |

            Example: Authorization
          example: Authorization
        isCompleted:
          type: boolean
          description: |
            Indicates the POS transaction completion status.

            If `true`, the transaction is complete.<br>
            If `false`, the transaction is being processed.
            The POS transaction status can still be changed.

            Example: true
          example: true
      additionalProperties: false
    Contracts.Page.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PosService.Contracts.PosTransactions.Get.ListPosTransactionsResponseDto
          nullable: true
        total:
          type: integer
          format: int32
          description: >
            Indicates the total number of POS (point of service) transactions
            found.


            Example: 124
          example: 124
      additionalProperties: false
    PosService.Contracts.Enums.PosTransactionReadingMethod:
      type: integer
      description: >
        Set the credit card reading method for the transaction.


        Possible values:


        | Value | Name     |
        Description                                                  |

        |:-----:|----------|--------------------------------------------------------------|

        | 1     | Reading  | Regular card reading method (Tap, Insert or Swipe)
        [default] |

        | 2     | KeyedIn  | Manual entry of card details
        (Keyed-in)                      |


        Example: 1
      example: 1
      format: int32
      nullable: true
    PosService.Contracts.PosTransactions.Create.CreatePosTransactionRequestDto:
      type: object
      required:
        - amount
        - currencyId
        - posDeviceId
        - terminalId
        - transactionTypeId
        - waitForAcceptanceByTerminal
        - targetTransactionId
      properties:
        amount:
          type: number
          description: >
            Specifies the total transaction amount (in USD).


            <span class="note">

            This is required when `transactionTypeId` is:


            | Id | Type          | Remark |

            |----|---------------|--------|

            | 1  | Authorization | |

            | 2  | Sale          | |

            | 7  | RefundWORef   | Refund without reference.<br><br>As a
            warning, these are considered high-risk transaction types, as funds
            are debited directly from the merchant's account even if the
            original sale was not processed through Flute. |

            | 8  | TipAdjustment | |


            </span>


            Example: 45.99
          example: 45.99
          format: integer
          nullable: true
        currencyId:
          type: integer
          description: >
            Specifies the Flute currency identifier.


            Always set to *1*.



            This is required when ` transactionTypeId` is:


            | Id | Type          | Remark |

            |----|---------------|--------|

            | 1  | Authorization | |

            | 2  | Sale          | |

            | 7  | RefundWORef   | Refund without reference.<br><br>As a
            warning, these are considered high-risk transaction types, as funds
            are debited directly from the merchant's account even if the
            original sale was not processed through Flute. |

            | 8  | TipAdjustment | |



            Example: 1
          example: 1
          format: integer
          nullable: true
        posDeviceId:
          type: string
          minLength: 1
          maxLength: 36
          description: |
            Specifies the External POS (point of sale) device identifier.

            Example: 000000001
          example: '000000001'
        terminalId:
          type: string
          format: uuid
          description: >
            Specifies the terminal identifier.


            This is the terminal used to initiate and handle the transaction.


            This terminal must be in the semi-integrated mode and available
            (online and ready).


            Example: 914358ab-efd7-4c5c-8570-fe4c0370fc37
          example: 914358ab-efd7-4c5c-8570-fe4c0370fc37
        transactionTypeId:
          $ref: '#/components/schemas/PosService.Contracts.TransactionType'
        waitForAcceptanceByTerminal:
          type: boolean
          description: >
            Specifies the long polling response mode.


            If `true`, use the long pooling response mode.

            The HTTP response will be provided once the terminal either:

            - accepts or declines to initiate the transaction

            - times out (terminal does not respond).


            If `false`, use the short pooling response mode.

            The HTTP response will be returned immediately, while the terminal
            is still receiving the transaction request.


            In either result, use **Gets POS transaction by ID** (`GET
            {{baseURL}}/pos-api/v1/pos-transactions/{{posTransactionsid}}`) to
            retrieve the latest information of the transaction submission.


            Example: true
          example: true
        requestPaymentMethodStorageConsent:
          type: boolean
          default: false
          description: >
            Specifies showing a popup about saving customer payment method
            information on the terminal.


            If `true`, show a popup about saving customer payment method
            information on the terminal.<br>

            If `false`, do not show a popup about saving customer payment method
            information on the terminal.


            Example: true
          example: true
        targetTransactionId:
          type: string
          format: uuid
          nullable: true
          description: |
            Specifies the transaction identifier.


            This is required for the following operations:

            * Capture
            * Void
            * Refund
            * TipAdjustment

            Example: 250521bd-1e4e-4363-8381-de512760d19a
          example: 250521bd-1e4e-4363-8381-de512760d19a
        referenceId:
          type: string
          minLength: 0
          maxLength: 36
          description: Specifies the external transaction reference identifier.
          nullable: true
        useCardPrice:
          type: boolean
          description: >
            Set the type of price being sent in the `amount` parameter.


            This field is mandatory only if the merchant's
            ZeroCostProcessingOption is Dual Pricing.

            For other ZeroCostProcessingOption values, set it as `null`.


            If `ZeroCostProcessingOption` is `Dual Pricing`, set
            `useCardPrice=true`.<br>

            If the `amount` contains the card price, or
            `useCardPrice=false`.<br>

            If the `amount` contains the cash price.


            The application will automatically calculate the total amounts by
            each payment method based on these inputs.
          nullable: true
        paymentProcessorId:
          type: string
          description: >-
            Set the Payment Processor ID to be used in the transaction. If not
            provided, it will use the merchant's default processor.
          format: uuid
          nullable: true
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        readingMethodId:
          $ref: >-
            #/components/schemas/PosService.Contracts.Enums.PosTransactionReadingMethod
      additionalProperties: false
    PosService.Contracts.PosTransactions.PosTransactionResponseDto:
      type: object
      properties:
        posTransactionId:
          type: string
          description: |
            Indicates the POS transaction identifier.

            Example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7
          example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7
          format: uuid
        statusId:
          $ref: '#/components/schemas/PosService.Contracts.PosTransactionStatus'
        status:
          type: string
          description: |
            Indicates the status identifier.

            Possible values:

            | Name                       | Value |
            |----------------------------|:-----:|
            | TerminalConnecting         | 1     |
            | TransactionProcessing      | 2     |
            | DeclinedByProcessor        | 3     |
            | CancelByPos                | 4     |
            | CancelByTerminal           | 5     |
            | Completed                  | 6     |
            | Error                      | 7     |
            | Inconsistency              | 8     |
            | TerminalOffline            | 9     |
            | TransactionSentToProcessor | 10    |

            Example: TransactionProcessing
          example: TransactionProcessing
          nullable: true
          readOnly: true
      additionalProperties: false
    PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto.TransactionDto:
      type: object
      properties:
        transactionId:
          type: string
          description: Transaction ID
          format: uuid
        amount:
          type: number
          description: Transaction amount
          format: double
          nullable: true
        currencyId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
        transactionStatusId:
          type: integer
          format: int32
          description: |
            Indicates the transaction status identifier.

            Possible values:

            | Value | Status |
            |-------|--------|
            | 1 | Authorized |
            | 2 | Captured |
            | 3 | Voided |
            | 4 | Refunded |
            | 5 | Verified |
            | 6 | Settled |
            | 7 | PartiallyAuthorized |
            | 90 | Pending |
            | 91 | Declined |
            | 92 | Failed  |

            Example: 6
          example: 6
        transactionStatus:
          type: string
          nullable: true
          description: |
            Indicates the transaction status.

            Possible values:

            | Value               | Status |
            |---------------------|:------:|
            | Authorized          | 1      |
            | Captured            | 2      |
            | Voided              | 3      |
            | Refunded            | 4      |
            | Verified            | 5      |
            | Settled             | 6      |
            | PartiallyAuthorized | 7      |
            | Pending             | 90     |
            | Declined            | 91     |
            | Failed              | 92     |

            Example: Settled
          example: Settled
        transactionTypeId:
          type: integer
          format: int32
          description: |
            Indicates the transaction type identifier.

            Possible values:

            | Value | Type          |
            |:-----:|---------------|
            | 1     | Authorization |
            | 2     | Sale          |
            | 3     | Capture       |
            | 4     | Void          |
            | 5     | Refund        |
            | 6     | Verify        |

            Example: 5
          example: 5
        transactionType:
          type: string
          nullable: true
          description: |
            Indicates the transaction type name.

            Possible values:

            | Value         | Type  |
            |---------------|:-----:|
            | Authorization | 1     |
            | Sale          | 2     |
            | Capture       | 3     |
            | Void          | 4     |
            | Refund        | 5     |
            | Verify        | 6     |

            Example: Refund
          example: Refund
        authCode:
          type: string
          description: |
            Indicates the authorization code received for the transaction.

            Example: VTLMC1
          example: VTLMC1
          nullable: true
        mid:
          type: string
          nullable: true
          description: >
            Indicates the MID (merchant identifier) assigned to this
            transaction.


            Example: 43252511
          example: '43252511'
        tid:
          type: string
          nullable: true
          description: >
            Indicates the TID (terminal identifier) assigned to this
            transaction.


            Example: 8820432549239101
          example: '8820432549239101'
      additionalProperties: false
    PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          required: true
          description: |
            Indicates the POS transaction identifier.

            Example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7
          example: 102ae6f7-8a9b-4c0d-1e2f-3a4b5c6d7
        createdOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) when
            the POS transaction was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        modifiedOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            last POS transaction modification.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        merchantId:
          type: string
          description: |
            Indicates the identifier of the merchant.

            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          format: uuid
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        terminalId:
          type: string
          description: ID of terminal should handle POS Transaction
          format: uuid
        paymentProcessorId:
          type: string
          description: Predefined PaymentProcessorID
          format: uuid
          nullable: true
        posDeviceId:
          type: string
          description: External POS Device ID
          nullable: true
        referenceId:
          type: string
          description: External Reference Device ID
          nullable: true
        posTransactionStatusId:
          $ref: '#/components/schemas/PosService.Contracts.PosTransactionStatus'
        posTransactionStatus:
          type: string
          description: |
            Indicates the status identifier.

            Possible values:

            | Name                       | Value |
            |----------------------------|:-----:|
            | TerminalConnecting         | 1     |
            | TransactionProcessing      | 2     |
            | DeclinedByProcessor        | 3     |
            | CancelByPos                | 4     |
            | CancelByTerminal           | 5     |
            | Completed                  | 6     |
            | Error                      | 7     |
            | Inconsistency              | 8     |
            | TerminalOffline            | 9     |
            | TransactionSentToProcessor | 10    |

            Example: TransactionProcessing
          example: TransactionProcessing
          nullable: true
          readOnly: true
        transactionId:
          type: string
          description: ID of attached transaction. Available after processing.
          format: uuid
          nullable: true
        amount:
          type: number
          description: Transaction amount for transaction types requires Amount.
          format: double
          nullable: true
        currencyId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the Flute currency identifier.

            Always set to *1*.

            Example: 1
          example: 1
        targetTransactionId:
          type: string
          description: Transaction Id for Void, Capture, Refund.
          format: uuid
          nullable: true
        transactionTypeId:
          $ref: '#/components/schemas/PosService.Contracts.TransactionType'
        transactionType:
          type: string
          description: |
            Specifies transaction type being processed by the terminal.

            Possible values:

            | Id | Type          |
            |:--:|---------------|
            | 1  | Authorization |
            | 2  | Sale          |
            | 3  | Capture       |
            | 4  | Void          |
            | 5  | Refund        |

            Example: 1
          example: '1'
          nullable: true
          readOnly: true
        isCompleted:
          type: boolean
          description: |
            Indicates the POS transaction completion status.

            If `true`, the transaction is complete.<br>
            If `false`, the transaction is being processed.
            The POS transaction status can still be changed.

            Example: true
          example: true
        transaction:
          $ref: >-
            #/components/schemas/PosService.Contracts.PosTransactions.Get.GetPosTransactionResponseDto.TransactionDto
        transactionReceipt:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto
      additionalProperties: false
    PosService.Contracts.PosTransactions.PrintTransactionReceipt.PrintTransactionReceiptRequestDto:
      type: object
      properties:
        terminalId:
          type: string
          description: >-
            Terminal ID from the terminal that will initiate and handle the
            transaction receipt print request.

            Terminal must be in the semi-integrated mode and available (online
            and ready).
          format: uuid
      additionalProperties: false
    PosService.Contracts.Terminals.List.GetTerminalsResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        merchantId:
          type: string
          format: uuid
          nullable: true
          description: |
            Indicates the identifier of the merchant.

            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
        serialNumber:
          type: string
          nullable: true
        terminalManufacturer:
          type: string
          nullable: true
        terminalModel:
          type: string
          nullable: true
        deliveryStatusId:
          type: integer
          format: int32
        deliveryStatusName:
          type: string
          nullable: true
        createdOn:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) the
            terminal was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        modifiedOn:
          type: string
          format: date-time
          nullable: true
        merchantCompanyName:
          type: string
          nullable: true
        terminalModeId:
          type: integer
          format: int32
        terminalModeName:
          type: string
          nullable: true
          readOnly: true
        connectionStatusId:
          type: integer
          format: int32
          nullable: true
        connectionStatus:
          type: string
          nullable: true
          readOnly: true
        lastSeenTimestamp:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) the
            terminal was last seen or used.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
      additionalProperties: false
    Contracts.Page.Contracts.Terminals.List.GetTerminalsResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PosService.Contracts.Terminals.List.GetTerminalsResponseDto
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of terminals found.

            Example: 3
          example: 3
      additionalProperties: false
    PosService.Contracts.Enums.TerminalConnectionStatus:
      type: integer
      description: |
        Possible values:
        <ul>
        <li><b>1 - Online</b>: </li>
        <li><b>2 - Offline</b>: </li>
        </ul>
      format: int32
    PosService.Contracts.Enums.TerminalConnectionType:
      type: integer
      description: |
        Possible values:

        <ul>
        <li><b>1 - WiFi</b>: </li>
        <li><b>2 - Mobile</b>: </li>
        <li><b>3 - Ethernet</b>: </li>
        </ul>
      format: int32
    PosService.Contracts.Enums.TerminalDebitPinKey:
      type: integer
      description: |
        Possible values:
        <ul>
        <li><b>1 - Injected</b>: </li>
        <li><b>2 - Missing</b>: </li>
        </ul>
      format: int32
    PosService.Contracts.Enums.TerminalAvailabilityStatus:
      type: integer
      format: int32
      description: |
        Indicaates the terminal availability status.

        Possible values:

        | Id | Description |
        |:--:|-------------|
        | 1  | Ready       |
        | 2  | Busy        |

        Example: 1
      example: 1
    PosService.Contracts.Enums.TerminalPrinterStatus:
      type: integer
      description: |
        Possible values:
        <ul>
        <li><b>1 - Normal</b>: </li>
        <li><b>2 - NotNormal</b>: </li>
        <li><b>3 - NotSupported</b>: </li>
        </ul>
      format: int32
    PosService.Contracts.Terminals.Status.Get.Get.GetTerminalStatusResponseDto.DeviceSoftwareDetailsDto:
      type: object
      properties:
        operatingSystem:
          type: string
          description: Operating System
          nullable: true
        androidBaseServiceVersion:
          type: string
          description: Android Base Service Version
          nullable: true
        sunmiTrustedManagementVersion:
          type: string
          description: Sunmi Trusted Management Version
          nullable: true
        sunmiCloudConnectionVersion:
          type: string
          description: Sunmi Cloud Connection Version
          nullable: true
        sunmiPayHardwareServiceVersion:
          type: string
          description: Sunmi Pay Hardware Service Version
          nullable: true
        posStewardAppVersion:
          type: string
          description: POS Steward app version
          nullable: true
        remoteAssistanceAppVersion:
          type: string
          description: Remote Assistance app version
          nullable: true
        sunmiFutureXAppVersion:
          type: string
          description: SUNMI FutureX app version
          nullable: true
        sunmiRomVersion:
          type: string
          description: Sunmi ROM Version
          nullable: true
      additionalProperties: false
    PosService.Contracts.Enums.TerminalPosStatus:
      type: integer
      format: int32
      description: |
        Indicates the terminal availability status.

        Possible values:

        | Id | Description |
        |:--:|-------------|
        | 1  | Ready |
        | 2  | Busy |

        Example: 1
      example: 1
    PosService.Contracts.Terminals.Status.Retrieve.RetrieveTerminalStatusResponseDto:
      type: object
      properties:
        terminalId:
          type: string
          description: Terminal Id
          format: uuid
        timestamp:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            terminal's status log.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        connectionStatusId:
          $ref: >-
            #/components/schemas/PosService.Contracts.Enums.TerminalConnectionStatus
        connectionStatus:
          type: string
          nullable: true
          readOnly: true
        connectionTypeId:
          $ref: >-
            #/components/schemas/PosService.Contracts.Enums.TerminalConnectionType
        connectionType:
          type: string
          nullable: true
          readOnly: true
        wifiConnectionStrength:
          type: integer
          description: Wifi Connection Strength 0-100
          format: int32
        mobileConnectionStrength:
          type: integer
          description: Mobile Connection Strength 0-100
          format: int32
        lastSeenTimestamp:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            terminal's online status.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        debitPinKeyId:
          $ref: '#/components/schemas/PosService.Contracts.Enums.TerminalDebitPinKey'
        debitPinKey:
          type: string
          nullable: true
          readOnly: true
        availabilityStatusId:
          $ref: >-
            #/components/schemas/PosService.Contracts.Enums.TerminalAvailabilityStatus
        availabilityStatus:
          type: string
          nullable: true
          readOnly: true
        ariseTerminalVersion:
          type: string
          description: ARISE Terminal version
          nullable: true
        batteryLevel:
          type: integer
          description: Battery Level 0-100
          format: int32
        printerStatusId:
          $ref: >-
            #/components/schemas/PosService.Contracts.Enums.TerminalPrinterStatus
        printerStatus:
          type: string
          nullable: true
          readOnly: true
        deviceSoftwareDetails:
          $ref: >-
            #/components/schemas/PosService.Contracts.Terminals.Status.Get.Get.GetTerminalStatusResponseDto.DeviceSoftwareDetailsDto
        terminalPosStatusId:
          $ref: '#/components/schemas/PosService.Contracts.Enums.TerminalPosStatus'
        terminalPosStatus:
          type: string
          description: >-
            Terminal Status name.

            Active = 1 - terminal is online and ready to accept the POS
            transaction

            Busy = 2 - terminal is online, but cannot accept the POS transaction

            Offline = 3 - terminal is not subscribed for push notifications, or
            didn't respond before timeout issued
          nullable: true
          readOnly: true
      additionalProperties: false
    PaymentIntegrations.Contracts.Categories.Get.GetCategoriesResponseDto:
      type: object
      description: Represents the response DTO for retrieving categories.
      properties:
        name:
          type: string
          description: |
            Indicates the name of the category.

            Example: After-market sales
          example: After-market sales
          nullable: true
        id:
          type: string
          format: uuid
          description: |
            Indicates the identifier of the category.

            Example: 567ef5a6-7b8c-4d9e-0f1a-2b3c4d5e6f92
          example: 567ef5a6-7b8c-4d9e-0f1a-2b3c4d5e6f92
        defaultUnitTypeId:
          type: integer
          description: |
            Indicates the default unit type identifier for the category, if any.

            Example: 32
          example: 32
          format: int32
          nullable: true
        itemCount:
          type: integer
          format: int32
          description: |
            Indicates the count of categories.

            Example: 8
          example: 8
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Get.GetIsvCategoriesPageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Categories.Get.GetCategoriesResponseDto
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of categories found.

            Example: 7
          example: 7
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Create.CreateIsvCategoryRequest:
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: |
            Specifies the name of the category.

            Example: Desserts
          example: Desserts
        defaultUnitTypeId:
          type: integer
          format: int32
          nullable: true
          description: |
            Specifies the default unit type identifier for the category.

            Example: 3
          example: 3
      additionalProperties: false
    PaymentIntegrations.Contracts.Categories.Create.CreateCategoryResponseDto:
      type: object
      description: Indicates an object representing the newly created category.
      properties:
        id:
          type: string
          format: uuid
          description: |
            Indicates the identifier of the created category.

            Example: 6780a6b7-8c9d-4e0f-1a2b-3c4d5e6f7a03
          example: 6780a6b7-8c9d-4e0f-1a2b-3c4d5e6f7a03
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Categories.Update.UpdateCategoryRequest:
      type: object
      description: Specifies an object with the new category information.
      properties:
        name:
          type: string
          description: |
            Specifies the new name of the category.

            Example: Direct Sales
          example: Direct Sales
          nullable: true
        defaultUnitTypeId:
          type: integer
          description: |
            Specifies the new default unit type identifier for the category.

            Example: 2
          example: 2
          format: int32
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.Enums.InvoiceStatus:
      type: integer
      description: |
        Possible values:

        | Value | Name              |
        |-------|-------------------|
        | 1     | Draft             |
        | 2     | Published         |
        | 3     | Paid              |
        | 4     | Expired           |
        | 5     | Canceled          |
        | 6     | ProcessingPayment |
        | 7     | Refunded          |

        Example: 2
      example: 2
      format: int32
    PaymentIntegrations.Contracts.Invoices.Get.GetInvoicesResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        number:
          type: string
          nullable: true
        customerName:
          type: string
          nullable: true
        issueDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            invoice's issue.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        dueDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) the
            due date of the invoice.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        paymentDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            invoice's payment date.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
        status:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Enums.InvoiceStatus
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Get.GetIsvInvoicesPageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoicesResponseDto
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of invoices found.

            Example: 5
          example: 5
      additionalProperties: false
    invoice_duedate:
      type: string
      format: date-time
      nullable: true
      description: >
        Specifies the date-time (in an ISO 8601 date-time UTC format) the
        invoice is due.


        Examples:2026-02-19T20:24:52.934Z
      example: '2026-02-19T20:24:52.934Z'
    cardPaymentProcessorid:
      type: string
      format: uuid
      nullable: true
      description: >
        Specifies an identifier for the credit card payment processor handling a
        card transaction.


        Example: 78723ff2-d47e-460b-b838-d602bdf0e1bc
      example: 78723ff2-d47e-460b-b838-d602bdf0e1bc
    ach_paymentrocessorid:
      type: string
      format: uuid
      nullable: true
      description: >
        Specifies an identifier for the automated clearing house (ACH) payment
        processor handling a transaction.


        Example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729
      example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729
    PaymentIntegrations.Contracts.Invoices.InvoiceAddressDto:
      type: object
      properties:
        line1:
          type: string
          description: |
            Indicates the street address.

            Example: 21 E. Main Street
          example: 21 E. Main Street
          nullable: true
        line2:
          type: string
          description: |
            Indicates additional street address information.

            Example: Apt. Block 6
          example: Apt. Block 6
          nullable: true
        city:
          type: string
          description: |
            Identifies the name of the city.

            Example: Chicago
          example: Chicago
          nullable: true
        zip:
          type: string
          nullable: true
          description: |
            Indicates the postal or ZIP code.

            Examples:<br>
            60612<br>
            60612-0001
          example: '60612'
        countryId:
          type: integer
          format: int32
          nullable: true
          description: >
            Specifies the <a href="#flute-countries-codes">Flute country
            identifier</a>.


            Example: 1
          example: 1
        stateId:
          type: integer
          description: >
            Specifies the <a href="#flute-states-codes">Flute US state or
            territory identifier code</a>.


            Example: 1
          example: 1
          format: int32
          nullable: true
        stateName:
          type: string
          description: |
            Indicates the full state name.

            Examples:<br>
            Texas<br>
            Washington<br>
            Illinois
          example: Illinois
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto:
      type: object
      properties:
        firstName:
          type: string
          description: |
            Indicates the customer's first name.

            Example: Alexandro
          example: Alexandro
          nullable: true
        lastName:
          type: string
          description: |
            Indicates the customer's last name.

            Example: Peppared
          example: Peppared
          nullable: true
        companyName:
          type: string
          description: |
            Indicates the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: Peppared Street Cafe
          nullable: true
        email:
          type: string
          description: |
            Indicates the customer's email.

            Example: peppared@example.com
          example: peppared@example.com
          nullable: true
        mobilePhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Indicates the customer's mobile phone number.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        isMobileNumberSmsNotificationsEnabled:
          type: boolean
          description: |
            Indicates the customer's SMS notification is enabled.

            If `true`, the customer's SMS notification is enabled.<br>
            If `false`, the customer's SMS notification is not enabled.<br>
            If missing or omitted, the information is not available.

            Example: true
        useBillingAsShippingAddress:
          type: boolean
          description: |
            Indicates to use the billing address as the shipping address.

            If `true`, use the billing address as the shipping address.<br>
            If `false`, do not use the billing address as the shipping address.
            Instead, use the field `shippingAddress`.

            Example: true
          example: true
        billingAddress:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceAddressDto
        shippingAddress:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceAddressDto
      additionalProperties: false
    PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
          description: |
            Indicates the identifier of the item.

            Example: d0f6d7e8-9f0a-4b1c-2d3e-4f5a6b7c8d14
          example: d0f6d7e8-9f0a-4b1c-2d3e-4f5a6b7c8d14
        lineItemId:
          type: string
          format: uuid
          description: |
            Indicates the identifier of the line item.

            Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        unitTypeId:
          type: integer
          format: int32
          description: >
            Indicates the identifier of the unit type.


            This is a numeric identifier represents the unit of measure for the
            item.

            Each supplier provides their own lookup value.

            That value maps to a predefined unit type in their system.


            Example: 1
          example: 1
        productName:
          type: string
          nullable: true
          description: |
            Indicates the name of the item.

            Example: RollerMouse Wireless Mouse
          example: RollerMouse Wireless Mouse
        description:
          type: string
          nullable: true
          description: >
            Indicates a description of the item.


            Example: RollerMouse Design Collection, Limited Edition Wireless
            Mouse
          example: RollerMouse Design Collection, Limited Edition Wireless Mouse
        sku:
          type: string
          nullable: true
          description: |
            Indicates the product identifier item.

            Example: 24474771
          example: '24474771'
        unitPrice:
          type: number
          format: double
          nullable: true
          description: |
            Indicates the unit price of the item.

            Example: 18.99
          example: 18.99
        quantity:
          type: number
          format: double
          description: |
            Indicates the quantity, or number, of the items

            Example: 10
          example: 10
        discountPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Indicates the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Create.CreateIsvInvoiceRequest:
      type: object
      properties:
        dueDate:
          $ref: '#/components/schemas/invoice_duedate'
        cardPaymentProcessorId:
          $ref: '#/components/schemas/cardPaymentProcessorid'
        achPaymentProcessorId:
          $ref: '#/components/schemas/ach_paymentrocessorid'
        additionalNotes:
          type: string
          nullable: true
          description: |
            Specifies additional notes or comments.

            Example: Extension permitted for 30 days.
          example: Extension permitted for 30 days.
        shippingAmount:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the shipping amount (in USD).

            Example: 129.99
          example: 129.99
        taxPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the tax percentage.

            Example: 8.50 (as 8.50%)
          example: 8.5
        feesPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the fees percentage.

            Example: 10.25 (as 10.25%)
          example: 10.25
        discountPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        merchantContactInfoId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates the merchant’s stored contact information record used on
            invoices and payment flows.


            Example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92
          example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        achAllowFasterProcessing:
          type: boolean
          nullable: true
        customer:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto
        lineItems:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto
          nullable: true
        canPriceBeForceOverrided:
          type: boolean
      additionalProperties: false
    PaymentIntegrations.Contracts.Invoices.Create.CreateInvoiceResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: |
            Indicates the invoice identifier.

            Example: cef5c6d7-8e9f-4a0b-1c2d-3e4f5a6b7c03
          example: cef5c6d7-8e9f-4a0b-1c2d-3e4f5a6b7c03
      additionalProperties: false
    PaymentIntegrations.Contracts.Invoices.InvoiceMerchantContactInfoDto:
      type: object
      properties:
        addressLine1:
          type: string
          nullable: true
          description: |
            Specifies the street address.

            Example: 21 E. Main Street
          example: 21 E. Main Street
        addressLine2:
          type: string
          nullable: true
          description: |
            Specifies additional street address information.

            Example: Office 3
          example: Office 3
        city:
          type: string
          nullable: true
          description: |
            Indicates the name of the city.

            Example: Chicago
          example: Chicago
        zip:
          type: string
          nullable: true
          description: |
            Indicates the postal or ZIP code.

            Examples:<br>
            60612<br>
            60612-0001
          example: '60612'
        countryId:
          type: integer
          format: int32
          description: >
            Specifies the <a href="#flute-countries-codes">Flute country
            identifier</a>.


            Example: 1
          example: 1
        stateId:
          type: integer
          format: int32
          nullable: true
          description: >
            Specifies the <a href="#flute-states-codes">Flute US state or
            territory identifier code</a>.


            Example: 4
          example: 4
        stateName:
          type: string
          description: |
            Indicates the full state name.

            Examples:<br>
            Texas<br>
            Washington<br>
            Illinois
          example: Illinois
          nullable: true
        email:
          type: string
          nullable: true
          description: |
            Indicates the customer's email.

            Example: peppared@example.com
          example: peppared@example.com
        businessPhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          nullable: true
          description: |
            Indicates the business's mobile phone number.

            Example: +14155552309
          example: '+14155552309'
      additionalProperties: false
    PaymentIntegrations.Contracts.Invoices.InvoiceHistoryDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        invoiceId:
          type: string
          format: uuid
        typeId:
          type: integer
          format: int32
        typeName:
          type: string
          nullable: true
        errorCode:
          type: string
          nullable: true
        errorMessage:
          type: string
          nullable: true
          description: |
            Indicates an error message.

            Example: Recipient not available
          example: Recipient not available
        notificationId:
          type: string
          format: uuid
          nullable: true
        notificationType:
          type: string
          nullable: true
        notificationTypeId:
          type: integer
          format: int32
          nullable: true
        notificationTemplateType:
          type: string
          nullable: true
        notificationTemplateTypeId:
          type: integer
          format: int32
          nullable: true
        notificationTarget:
          type: string
          nullable: true
        transactionId:
          type: string
          format: uuid
          nullable: true
        paymentMethodTypeId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
        createdOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) the
            invoice was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
      additionalProperties: false
    PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceAmountsDto:
      type: object
      properties:
        subTotalAmount:
          type: number
          format: double
          description: |
            Specifies the transaction's subtotal amount.

            This includes the base amount, tips, taxes, and discounts.

            Example: 3219.45
          example: 3219.45
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
        shippingAmount:
          type: number
          format: double
          description: |
            Indicates the shipping amount (in USD).

            Example: 129.99
          example: 129.99
        taxAmount:
          type: number
          format: double
        taxPercentage:
          type: number
          format: double
        description: |
          Indicates the tax percentage.

          Example: 8.50 (as 8.50%)
        example: 8.5
        feesAmount:
          type: number
          format: double
          description: |
            Indicates the fees amount (in USD).

            Example: 35.00
          example: 35
        feesPercentage:
          type: number
          format: double
          description: |
            Indicates the fees percentage.

            Example: 10.25 (as 10.25%)
          example: 10.25
        discountAmount:
          type: number
          format: double
        discountPercentage:
          type: number
          format: double
          description: |
            Indicates the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        surchargeAmount:
          type: number
          format: double
          description: >
            Identifies the amount (in USD) when a surcharge is applicable.


            This is a surcharge on the base amount.

            This surcharge was calculated using the preset percentage from
            `surchargePercentage`.


            Example: 6.45
          example: 6.45
        surchargePercentage:
          type: number
          format: double
          description: >
            Identifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        cashDiscountAmount:
          type: number
          format: double
          description: >
            Identifies the discount amount (in USD) when a cash (or
            cash-equivalent) discount is applied.


            This discount was calculated using the preset percentage from
            `cashDiscountRate`.


            Example: 10.55
          example: 10.55
        cashDiscountPercentage:
          type: number
          format: double
          description: >
            Identifies the discount percentage for a cash (or cash-equivalent)
            discount.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `cashDiscountAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
      additionalProperties: false
    PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceCalculationsDto:
      type: object
      properties:
        debitCard:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceAmountsDto
        creditCard:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceAmountsDto
        ach:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceAmountsDto
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Get.GetIsvInvoiceResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        number:
          type: string
          nullable: true
        status:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Enums.InvoiceStatus
        issueDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            invoice's issue.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        dueDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            invoice due date.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        paymentDate:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            invoice payment.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        cardPaymentProcessorId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates an identifier for the credit card payment processor
            handling a transaction.


            example: acf3a4b5-6c7d-4e8f-9a0b-1c2d3e4f5a81
          example: acf3a4b5-6c7d-4e8f-9a0b-1c2d3e4f5a81
        achPaymentProcessorId:
          $ref: '#/components/schemas/ach_paymentrocessorid'
        additionalNotes:
          type: string
          nullable: true
          description: |
            Indicates additional notes or comments.

            Example: Extension permitted for 30 days.
          example: Extension permitted for 30 days.
        subTotalAmount:
          type: number
          format: double
          description: |
            Specifies the transaction's subtotal amount.

            This includes the base amount, tips, taxes, and discounts.

            Example: 3219.45
          example: 3219.45
        shippingAmount:
          type: number
          format: double
          description: |
            Indicates the shipping amount (in USD).

            Example: 129.99
          example: 129.99
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
        taxPercentage:
          type: number
          format: double
          description: |
            Indicates the tax percentage.

            Example: 8.50 (as 8.50%)
          example: 8.5
        feesPercentage:
          type: number
          format: double
          description: |
            Indicates the fees percentage.

            Example: 10.25 (as 10.25%)
          example: 10.25
        discountPercentage:
          type: number
          format: double
          description: |
            Indicates the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        surchargeAmount:
          type: number
          format: double
          description: >
            Identifies the amount (in USD) when a surcharge is applicable.


            This is a surcharge on the base amount.

            This surcharge was calculated using the preset percentage from
            `surchargePercentage`.


            Example: 6.45
          example: 6.45
        surchargePercentage:
          type: number
          format: double
          description: >
            Identifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        cashDiscountAmount:
          type: number
          format: double
          description: >
            Identifies the discount amount (in USD) when a cash (or
            cash-equivalent) discount is applied.


            This discount was calculated using the preset percentage from
            `cashDiscountRate`.


            Example: 10.55
          example: 10.55
        cashDiscountPercentage:
          type: number
          format: double
          description: >
            Identifies the discount percentage for a cash (or cash-equivalent)
            discount.


            This value is percentage rate for the discount.

            This discount percentage calculates the discount amount for
            `cashDiscountAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        paymentMethodTypeId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
        merchantId:
          type: string
          format: uuid
          description: |
            Indicates the identifier of the merchant.

            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
        merchantContactInfoId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates the merchant’s stored contact information record used on
            invoices and payment flows.


            Example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92
          example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92
        merchantContactInfo:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceMerchantContactInfoDto
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        customer:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto
        lineItems:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto
          nullable: true
        isCustomerUpdated:
          type: boolean
        isLineItemsUpdated:
          type: boolean
        fullUrl:
          type: string
          nullable: true
        shortUrl:
          type: string
          nullable: true
        markedAsPaid:
          type: boolean
          nullable: true
        transactionId:
          type: string
          format: uuid
          nullable: true
        achAllowFasterProcessing:
          type: boolean
          nullable: true
        history:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceHistoryDto
          nullable: true
        zeroCostProcessingOptionId:
          type: integer
          description: |-
            ZCP Option Id
            Available when invoice is in Published or Paid status
          format: int32
          nullable: true
        zeroCostProcessingOption:
          type: string
          description: >
            Specifies using the type of zero cost processing.


            Zero cost processing has the customer covering the card fees and not
            the merchant.


            Available when invoice is in `Published` or `Paid` status


            Possible values:


            | Type         | Id |

            |--------------|:--:|

            | None         | 1  |

            | CashDiscount | 2  |

            | DualPricing  | 3  |

            | Surcharge    | 4  |


            Example: DualPricing
          example: DualPricing
          nullable: true
        useCardPrice:
          type: boolean
          description: >-
            Available for ZCP Option == Dual pricing only, when invoice is in
            Published or Paid status

            true - dual pricing, use card price

            false - dual pricing, use cash price

            null - other ZCP option
          nullable: true
        invoiceCalculations:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.Get.GetInvoiceResponseDto.InvoiceCalculationsDto
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Update.UpdateIsvInvoiceRequest:
      type: object
      properties:
        dueDate:
          $ref: '#/components/schemas/invoice_duedate'
        cardPaymentProcessorId:
          $ref: '#/components/schemas/cardPaymentProcessorid'
        achPaymentProcessorId:
          $ref: '#/components/schemas/ach_paymentrocessorid'
        additionalNotes:
          type: string
          description: |
            Specifies additional notes or comments.

            Example: Extension permitted for 30 days.
          example: Extension permitted for 30 days.
          nullable: true
        shippingAmount:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the shipping amount (in USD).

            Example: 129.99
          example: 129.99
        taxPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the tax percentage.

            Example: 8.50 (as 8.50%)
          example: 8.5
        feesPercentage:
          type: number
          format: double
          description: |
            Specifies the fees percentage.

            Example: 10.25 (as 10.25%)
          example: 10.25
          nullable: true
        discountPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the discount percentage.

            Example: 1.75 (as 1.75%)
          example: 1.75
        description: |
          Specifies the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        merchantContactInfoId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates the merchant’s stored contact information record used on
            invoices and payment flows.


            Example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92
          example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        achAllowFasterProcessing:
          type: boolean
          nullable: true
        customer:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto
        lineItems:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto
          nullable: true
        canPriceBeForceOverrided:
          type: boolean
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceRequest:
      type: object
      properties:
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
        accountNumber:
          type: string
          nullable: true
          description: |
            Specifies the payment target's bank account number.

            Example: 5413591081013511
          example: '5413591081013511'
        expirationMonth:
          type: integer
          format: int32
          description: |
            Specifies the expiration month of the card.

            Example: 7
          example: 7
        expirationYear:
          type: integer
          format: int32
          description: |
            Specifies the expiration year of the card.

            Example: 2032
          example: 2032
        securityCode:
          type: string
          nullable: true
        billingCountryId:
          type: integer
          format: int32
          description: >
            Specifies the <a href="#flute-countries-codes">Flute country
            identifier</a>.


            Example: 1
          example: 1
        billingPostalCode:
          type: string
          nullable: true
          description: |
            Specifies the billing postal or ZIP code.

            Examples:<br>
            60612<br>
            60612-0001
          example: '60612'
        savePaymentMethod:
          type: boolean
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Submit.SubmitIsvInvoiceResponse:
      type: object
      properties:
        success:
          type: boolean
          description: |
            Indicates the payment was successfully submitted.

            If `true`, the payment was successfully submitted.<br>
            If `false`, the payment was not successfully submitted.

            Example: true
          example: true
        paymentMethodCreated:
          type: boolean
          description: |
            Indicates the payment method was created.

            If `true`, the payment method was created.<br>
            If `false`, the payment method was not created.

            Example: true
          example: true
        customerInfoSaved:
          type: boolean
          description: |
            Indicates the customer info was saved.

            If `true`, the customer info was saved.<br>
            If `false`, the customer info was not saved.

            Example: true
          example: true
      additionalProperties: false
    PaymentIntegrations.Contracts.Enums.AccountType:
      type: integer
      description: |
        Possible values:

        | Value | Name     |
        |-------|----------|
        | 1     | Checking |
        | 2     | Savings  |

        Example: 1
      example: 1
      format: int32
    PaymentIntegrations.Contracts.Enums.AccountHolderType:
      type: integer
      description: |
        Possible values:

        | Value | Name     |
        |-------|----------|
        | 1     | Business |
        | 2     | Personal |

        Example: 1
      example: 1
      format: int32
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SubmitAch.SubmitIsvAchInvoiceRequest:
      type: object
      properties:
        accountNumber:
          $ref: '#/components/schemas/ach_accountnumber'
        routingNumber:
          $ref: '#/components/schemas/ach_routingnumber'
        accountType:
          $ref: '#/components/schemas/PaymentIntegrations.Contracts.Enums.AccountType'
        accountHolderType:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Enums.AccountHolderType
        firstName:
          type: string
          description: |
            Indicates the customer's first name.

            Example: Alexandro
          example: Alexandro
        lastName:
          type: string
          description: |
            Indicates the customer's last name.

            Example: Peppared
          example: Peppared
        companyName:
          type: string
          description: |
            Indicates the name of the customer's company or organization.

            Example: Peppared Street Cafe
          example: Peppared Street Cafe
          nullable: true
        email:
          type: string
          description: |
            Indicates the customer's email.

            Example: peppared@example.com
          example: peppared@example.com
          nullable: true
        mobilePhoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          description: |
            Indicates the customer's mobile phone number.

            Example: +14155552309
          example: '+14155552309'
          nullable: true
        smsNotification:
          type: boolean
          nullable: true
          default: false
          description: |
            Specifies the customer is sent an SMS notification.

            If `true`, the customer is sent an SMS notification.<br>
            If `false`, the customer is not sent an SMS notification.

            Example: true
          example: true
        addressLine1:
          type: string
          nullable: true
          description: |
            Indicates the street address.

            Example: 21 E. Main Street
          example: 21 E. Main Street
        addressLine2:
          type: string
          nullable: true
          description: |
            Specifies additional street address information.

            Example: Office 3
          example: Office 3
        city:
          type: string
          description: |
            Specifies the name of the city.

            Example: Chicago
          example: Chicago
          nullable: true
        stateId:
          type: integer
          format: int32
          description: >
            Specifies the <a href="#flute-states-codes">Flute US state or
            territory identifier code</a>.


            Example: 4
          example: 4
        billingPostalCode:
          type: string
          nullable: true
          description: |
            Specifies the billing postal or ZIP code.

            Examples:<br>
            60612<br>
            60612-0001
          example: '60612'
        savePaymentMethod:
          type: boolean
        authorizeBankWithdrawal:
          type: boolean
        authorizationConsentTimestamp:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) when
            customer checked the authorization checkbox.


            This is required for ACH compliance audit logging.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Calculations.GetIsvInvoiceCalculationsResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        subTotalAmount:
          type: number
          format: double
          description: |
            Specifies the transaction's subtotal amount.

            This includes the base amount, tips, taxes, and discounts.

            Example: 3219.45
          example: 3219.45
        shippingAmount:
          type: number
          format: double
          description: |
            Indicates the shipping amount (in USD).

            Example: 129.99
          example: 129.99
        taxPercentage:
          type: number
          format: double
          description: |
            Indicates the tax percentage.

            Example: 8.50 (as 8.50%)
          example: 8.5
        taxAmount:
          type: number
          format: double
        feesPercentage:
          type: number
          format: double
          description: |
            Indicates the fees percentage.

            Example: 10.25 (as 10.25%)
          example: 10.25
        feesAmount:
          type: number
          format: double
          description: |
            Indicates the fees amount (in USD).

            Example: 35.00
          example: 35
        discountPercentage:
          type: number
          format: double
          description: |
            Indicates the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        discountAmount:
          type: number
          format: double
        surchargeAmount:
          type: number
          format: double
          description: >
            Identifies the amount (in USD) when a surcharge is applicable.


            This is a surcharge on the base amount.

            This surcharge was calculated using the preset percentage from
            `surchargePercentage`.


            Example: 6.45
          example: 6.45
        surchargePercentage:
          type: number
          format: double
          nullable: true
          description: >
            Identifies the surcharge percentage.


            This is a surcharge on the base amount.

            This value is surcharge percentage rate.

            This surcharge percentage calculates the surcharge amount for
            `surchargeAmount`.


            Example: 1.5 (as 1.5%)
          example: 1.5
        totalAmount:
          type: number
          format: double
          description: >
            Specifies the transaction's total amount.


            This includes the base amount, tips, taxes, shipping, discounts, and
            other charges.


            Example: 3219.45
          example: 3219.45
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Publish.PublishIsvInvoiceRequest:
      type: object
      properties:
        dueDate:
          $ref: '#/components/schemas/invoice_duedate'
        cardPaymentProcessorId:
          $ref: '#/components/schemas/cardPaymentProcessorid'
        achPaymentProcessorId:
          $ref: '#/components/schemas/ach_paymentrocessorid'
        additionalNotes:
          type: string
          nullable: true
          description: |
            Indicates additional notes or comments.

            Example: Extension permitted for 30 days.
          example: Extension permitted for 30 days.
        shippingAmount:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the shipping amount (in USD).

            Example: 129.99
          example: 129.99
        taxPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the tax percentage.

            Example: 8.50 (as 8.50%)
          example: 8.5
        feesPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the fees percentage.

            Example: 10.25 (as 10.25%)
          example: 10.25
        discountPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        merchantContactInfoId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates the merchant’s stored contact information record used on
            invoices and payment flows.


            Example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92
          example: bdf4b5c6-7d8e-4f9a-0b1c-2d3e4f5a6b92
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289d
          example: fd9198a4-eb6f-4620-9603-4f4638289d
        achAllowFasterProcessing:
          type: boolean
          nullable: true
        customer:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto
        lineItems:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto
          nullable: true
        canPriceBeForceOverrided:
          type: boolean
        id:
          type: string
          format: uuid
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Publish.PublishIsvInvoiceResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.Update.UpdateIsvInvoiceStatusRequest:
      type: object
      properties:
        paymentMethodTypeId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SendInvoicePublishedSmsNotification.SendIsvInvoicePublishedSmsNotificationRequest:
      type: object
      properties:
        phoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          nullable: true
          description: |
            Indicates the SMS phone number.

            Example: +14155552309
          example: '+14155552309'
        customerConsent:
          type: boolean
          description: |
            Identifies the customer has consented to receiving the SMS.

            If `true`, the customer has consented to receiving the SMS.<br>
            If `false`, the customer has not consented to receiving the SMS.

            Example: true
          example: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.Invoices.SendInvoiceEmailNotification.SendInvoiceEmailNotificationRequest:
      type: object
      properties:
        receiverEmail:
          type: string
          nullable: true
        customerConsent:
          type: boolean
          description: |
            Identifies the customer has consented to receiving the SMS.

            If `true`, the customer has consented to receiving the SMS.<br>
            If `false`, the customer has not consented to receiving the SMS.

            Example: true
          example: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.InvoiceSettings.Get.GetIsvInvoiceSettingsResponse:
      type: object
      properties:
        merchantId:
          type: string
          format: uuid
          description: |
            Indicates the identifier of the merchant.

            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
        dueDateAfterDays:
          type: integer
          format: int32
          nullable: true
        taxPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Indicates the tax percentage.

            Example: 8.50 (as 8.50%)
          example: 8.5
        isDiscountEnabled:
          type: boolean
          description: |
            Indicates the discount is enabled.

            If `true`, the discount is enabled.<br>
            If `false`, the discount is not enabled.

            Example: true
          example: true
        discountPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Indicates the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        isShippingFeeEnabled:
          type: boolean
          description: |
            Indicates the shipping fee is enabled.

            If `true`, the shipping fee is enabled.<br>
            If `false`, the shipping fee is not enabled.

            Example: true
          example: true
        shippingFeeAmount:
          type: number
          format: double
          nullable: true
        isFeesEnabled:
          type: boolean
          description: |
            Specifies fees are enabled.

            If `true`, fees are enabled.<br>
            If `false`, fees are not enabled.

            Example: true
          example: true
        feesPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Indicates the fees percentage.

            Example: 10.25 (as 10.25%)
          example: 10.25
        notes:
          type: string
          nullable: true
        paymentMethodTypeId:
          type: integer
          format: int32
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
        cardPaymentProcessorId:
          $ref: '#/components/schemas/cardPaymentProcessorid'
        achPaymentProcessorId:
          $ref: '#/components/schemas/ach_paymentrocessorid'
        allowStaffToSetDiscountAndLineItemDiscount:
          type: boolean
        allowManuallyEnterLineItems:
          type: boolean
        isSmsNotificationAfterPaymentEnabled:
          type: boolean
        isSmsNotificationAfterPaymentFailedEnabled:
          type: boolean
        canOverWriteInvoiceLineItemPrice:
          type: boolean
        newZcpFeatureEnabled:
          type: boolean
      additionalProperties: false
    AspNet.Swagger.Examples.ForbiddenExceptionExample:
      type: object
      properties:
        details:
          type: string
          nullable: true
        statusCode:
          type: integer
          format: int32
          nullable: true
          description: >
            Specifies the HTTP response status code.


            This is the HTTP status code returned by the attempted delivery.


            The following is a list of HTTP response status codes that include
            but are not limited to:


            | HTTP Status | Meaning |

            |:-----------:|---------|

            | 200 | Delivery succeeded |

            | 400 | Bad request |

            | 401 | Unauthorized |

            | 404 | Endpoint not found |

            | 429 | Rate limited |


            Example: 401
          example: 401
        source:
          type: string
          nullable: true
        exceptionType:
          type: string
          nullable: true
        correlationId:
          type: string
          nullable: true
        entityId:
          type: string
          nullable: true
        errorCode:
          type: string
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.InvoiceSettings.Update.UpdateIsvInvoiceSettingsRequest:
      type: object
      properties:
        dueDateAfterDays:
          type: integer
          format: int32
          nullable: true
        taxPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the tax percentage.

            Example: 8.50 (as 8.50%)
          example: 8.5
        isDiscountEnabled:
          type: boolean
          description: |
            Specifies the discount is enabled.

            If `true`, enable the discount.<br>
            If `false`, do not enable the discount.

            Example: true
          example: true
        discountPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the discount percentage.

            Example: 1.5 (as 1.5%)
          example: 1.5
        isShippingFeeEnabled:
          type: boolean
          description: |
            Specifies the shipping fee is enabled.

            If `true`, the shipping fee is enabled.<br>
            If `false`, the shipping fee is not enabled.

            Example: true
          example: true
        shippingFeeAmount:
          type: number
          format: double
          nullable: true
        isFeesEnabled:
          type: boolean
          description: |
            Specifies fees are enabled.

            If `true`, fees are enabled.<br>
            If `false`, fees are not enabled.

            Example: true
          example: true
        feesPercentage:
          type: number
          format: double
          nullable: true
          description: |
            Specifies the fees percentage.

            Example: 10.25 (as 10.25%)
          example: 10.25
        notes:
          type: string
          nullable: true
        paymentMethodTypeId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
        cardPaymentProcessorId:
          $ref: '#/components/schemas/cardPaymentProcessorid'
        achPaymentProcessorId:
          $ref: '#/components/schemas/ach_paymentrocessorid'
        allowStaffToSetDiscountAndLineItemDiscount:
          type: boolean
        allowManuallyEnterLineItems:
          type: boolean
        isSmsNotificationAfterPaymentEnabled:
          type: boolean
        isSmsNotificationAfterPaymentFailedEnabled:
          type: boolean
        achAllowFasterProcessing:
          type: boolean
          nullable: true
        canOverWriteInvoiceLineItemPrice:
          type: boolean
      additionalProperties: false
    PaymentIntegrations.Contracts.LineItems.Get.GetLineItemsResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: |
            Indicates the identifier of the item.

            Example: d0f6d7e8-9f0a-4b1c-2d3e-4f5a6b7c8d14
          example: d0f6d7e8-9f0a-4b1c-2d3e-4f5a6b7c8d14
        unitType:
          type: string
          nullable: true
          description: >
            Indicates the unit of measure associated with the item.


            This is a string identifier represents the unit of measure for the
            item.

            Each supplier provides their own lookup value.

            That value maps to a predefined unit type in their system.


            See the field `unitTypeId` for a numeric equivalent.


            Example: Each
          example: Each
        unitTypeId:
          type: integer
          format: int32
          description: >
            Indicates the identifier of the unit type.


            This is a numeric identifier represents the unit of measure for the
            item.

            Each supplier provides their own lookup value.

            That value maps to a predefined unit type in their system.


            See the field `unitType` for a string equivalent.


            Example: 1
          example: 1
        productName:
          type: string
          nullable: true
          description: |
            Indicates the name of the item.

            Example: RollerMouse Wireless Mouse
          example: RollerMouse Wireless Mouse
        description:
          type: string
          nullable: true
          description: >
            Indicates a description of the item.


            Example: RollerMouse Design Collection, Limited Edition Wireless
            Mouse
          example: RollerMouse Design Collection, Limited Edition Wireless Mouse
        sku:
          type: string
          nullable: true
          description: |
            Indicates the product identifier item.

            Example: 24474771
          example: '24474771'
        unitPrice:
          type: number
          format: double
          description: |
            Indicates the unit price of the item.

            Example: 18.99
          example: 18.99
        categoryId:
          type: string
          format: uuid
          nullable: true
          description: |
            Indicates the identifier of the item category.

            Example: a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b67
          example: a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b67
        categoryName:
          type: string
          nullable: true
          description: |
            Indicates the category associated with the item.

            Example: Computer Accessories
          example: Computer Accessories
        categoryDefaultUnitTypeId:
          type: integer
          format: int32
          nullable: true
          description: >
            Indicates the default unit type identifier associated with the
            category.


            Example: 1
          example: 1
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Get.GetIsvLineItemsPageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.LineItems.Get.GetLineItemsResponseDto
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of line items found.

            Example: 26
          example: 26
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Create.CreateIsvLineItemRequest:
      type: object
      properties:
        productName:
          type: string
          nullable: true
          description: |
            Indicates the name of the item.

            Example: RollerMouse Wireless Mouse
          example: RollerMouse Wireless Mouse
        description:
          type: string
          nullable: true
          description: >
            Indicates a description of the item.


            Example: RollerMouse Design Collection, Limited Edition Wireless
            Mouse
          example: RollerMouse Design Collection, Limited Edition Wireless Mouse
        sku:
          type: string
          nullable: true
          description: |
            Indicates the product identifier item.

            Example: 24474771
          example: '24474771'
        unitPrice:
          type: number
          format: double
          description: |
            Indicates the unit price of the item.

            Example: 18.99
          example: 18.99
        unitTypeId:
          type: integer
          format: int32
          description: >
            Indicates the identifier of the unit type.


            This is a numeric identifier represents the unit of measure for the
            item.

            Each supplier provides their own lookup value.

            That value maps to a predefined unit type in their system.


            Example: 1
          example: 1
        categoryId:
          type: string
          format: uuid
          nullable: true
          description: |
            Indicates the identifier of the item category.

            Example: a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b68
          example: a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b68
        taxRate:
          type: number
          format: double
          description: |
            Indicates the type of tax rate.

            Example: 3.25 (as 3.25%)
          example: 3.25
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Create.CreateIsvLineItemResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Update.UpdateIsvLineItemRequest:
      type: object
      properties:
        productName:
          type: string
          nullable: true
          description: |
            Indicates the name of the item.

            Example: RollerMouse Wireless Mouse
          example: RollerMouse Wireless Mouse
        description:
          type: string
          nullable: true
          description: >
            Indicates a description of the item.


            Example: RollerMouse Design Collection, Limited Edition Wireless
            Mouse
          example: RollerMouse Design Collection, Limited Edition Wireless Mouse
        sku:
          type: string
          nullable: true
          description: |
            Indicates the product identifier item.

            Example: 24474771
          example: '24474771'
        unitPrice:
          type: number
          format: double
          description: |
            Indicates the unit price of the item.

            Example: 18.99
          example: 18.99
        unitTypeId:
          type: integer
          format: int32
          description: >
            Indicates the identifier of the unit type.


            This is a numeric identifier represents the unit of measure for the
            item.

            Each supplier provides their own lookup value.

            That value maps to a predefined unit type in their system.


            Example: 1
          example: 1
        categoryId:
          type: string
          format: uuid
          nullable: true
          description: |
            Indicates the identifier of the item category.

            Example: a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b67
          example: a2d1c4b5-6e7f-4890-9abc-1d2e3f4a5b67
        taxRate:
          type: number
          format: double
          description: |
            Indicates the type of tax rate.

            Example: 3.25 (as 3.25%)
          example: 3.25
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.LineItems.Get.GetIsvLineItemUnitTypesResponse:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
          nullable: true
        abbreviation:
          type: string
          nullable: true
        category:
          type: string
          nullable: true
      additionalProperties: false
    CreatePaymentSessionRequestDto:
      type: object
      required:
        - amount
      properties:
        amount:
          type: number
          format: double
          description: >
            For use with Flute Checkout also.


            Specifies the base amount (in USD) to charge.


            For payment sessions, this value must be greater than zero.<br>

            For vault-only sessions, this value must be zero.

            If null or omitted, this creates a flexible-amount session where the
            amount is set at checkout.


            Examples:<br>

            64.99<br>

            0

            null
          example: 64.99
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            For use with Flute Checkout also.


            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        mode:
          type: integer
          format: enum
          default: 1
          description: >
            For use with Flute Checkout also.


            Specifies the intent of the session.


            | Value | Name            |
            Description                                   |

            |:-----:|-----------------|-----------------------------------------------|

            | 1     | Payment         | Standard payment session. Makes
            `skipAddressVerification` applicable. Default. |

            | 2     | SaveMethod      | Vault-only session to store a payment
            method. |

            | 3     | PaymentAndSave  | Charge the payment and save the method.
            Makes `skipAddressVerification` applicable. |


            Example: 2
          example: 2
        skipAddressVerification:
          type: boolean
          default: false
          description: >
            Specifies to bypass the AVS (address verification service) in the
            payment gateway.


            This value is applicable only to `Payment` and `PaymentAndSave` from
            `mode`.


            If `true`, bypasses AVS in the payment gateway.<br>

            If `false`, does not bypass AVS in the payment gateway.


            Example: true
          example: true
        referenceId:
          type: string
          description: >
            Specifies a reference identifier provided by the ISV.


            This is included in the duplicate-check key.

            It allows the same card and amount combination to be charged
            multiple times when the reference identifies are different.


            Example: 10001
          example: '10001'
        tipAmount:
          type: number
          format: double
          nullable: true
          minimum: 0.01
          multipleOf: 0.01
          description: >
            Specifies the absolute amount (in USD) of the tip to be added.


            If this value is provided, it must be greater than zero.


            This amount adds to the base amount of the original transaction.

            That transaction must be authorized first (`POST
            /pay-api/v1/transactions/auth`).


            Example: 14.50
          example: 14.5
        customerHandling:
          format: string
          default: CreateCustomer
          description: |
            Specifies the intent of the session.

            | Name            | Description                                   |
            |-----------------|-----------------------------------------------|
            | CreateCustomer  |  |
            | TokenOnly       |  |

            Example: CreateCustomer
          example: CreateCustomer
        returnUrl:
          type: string
          format: URL
          description: >
            For use with Flute Checkout only.


            Specifies a target URL.


            The customer is redirected to this Web page after payment is
            completed.


            The request body field `returnUrl` value contains the literal string
            `{{paymentSessionId}}`.

            It is a placeholder.

            When this payment session endpoint successfully returned, Flute
            Checkout replaced the placeholder with the actual payment session
            identifier.


            Example:
            https://isv.example.com/payments/returnUrl/{{paymentSessionId}}
          example: https://isv.example.com/payments/returnUrl/{{paymentSessionId}}
        paymentMethodTypes:
          type: array
          nullable: true
          items:
            type: string
          description: |
            For use with Flute Checkout also.

            Specifies payment methods to be shown at checkout.

            Valid values are:

            | Payment method | Type |
            |----------------|------|
            | Card           | Credit or debit card payment |
            | ACH            | ACH (automated clearing house) payment |

            Example: Card
          example: Card
        afterCompletionMessage:
          type: string
          nullable: true
          description: >
            Specifies a message shown to the payer after the payment session
            completes.


            This value is not needed if using Flute Elements and Flute Checkout.


            Example: Thank you for shopping with us.
          example: Thank you for shopping with us.
        pageName:
          type: string
          nullable: true
          description: >
            Specifies the display name shown on the checkout page.


            This is a free-formed name that is convenient for the merchant to
            recognize.


            Example: Peppared Street Cafe's Preferred Payment
          example: Peppared Street Cafe's Preferred Payment
        paymentNotes:
          type: string
          nullable: true
          description: |
            Specifies additional notes shown to the payer on the checkout page.

            Example: The client's server is being repaired.
          example: The client's server is being repaired.
        expiresAt:
          type: string
          format: date-time
          description: >
            For use with Flute Checkout only.


            Specifies the expiration date and time (in an ISO 8601 date-time UTC
            format) of the transaction.


            If null or omitted, this defaults to 30 minutes.


            Example: 2026-01-19T14:27:02.767105Z
          example: '2026-01-19T14:27:02.767105Z'
        metadata:
          type: object
          nullable: true
          additionalProperties:
            type: string
            nullable: true
          description: >
            For use with Flute Checkout only.


            Specifies key-value pairings.


            This is an optional collection of key-value pairings to provide
            additional information for the checkout process.

            They are arbitrary values, often specific to the transaction.


            Content of the key-value pairs will be sanitized for security
            purposes.

            Maximum of 50 key-value pairings.

            Maximum 40 characters for the key name.

            Maximum 500 characters for the value.

            The maximum for the entire set of key-value pairings is 8 KB.


            Example:<br>

            { "orderId": "9921", "invoiceNumber": "INV-2026-001" }
          example:
            orderId: '9921'
            invoiceNumber: INV-2026-001
      additionalProperties: false
    CreatePaymentSessionResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >
            Indicates the payment session identifier.


            Use this value as the `paymentSessionId`.

            This value allows the customer to send the card information to
            complete the transaction.


            Example: 16143c97-07bc-448c-9807-924189311a66
          example: 16143c97-07bc-448c-9807-924189311a66
        mode:
          type: string
          default: 1
          description: >
            For use with Flute Checkout only.


            Indicates the intent of the session.


            | Name            | Description                                   |

            |-----------------|-----------------------------------------------|

            | Payment         | Standard payment session. Makes
            `skipAddressVerification` applicable. Default. |

            | SaveMethod      | Vault-only session to store a payment method. |

            | PaymentAndSave  | Charge the payment and save the method. Makes
            `skipAddressVerification` applicable. |


            Example: Payment
          example: Payment
        returnUrl:
          type: string
          format: URL
          description: >
            For use with Flute Checkout only.


            Indicates a target URL.


            The customer is redirected to this Web page after payment is
            completed.


            The request body field `returnUrl` value contains the literal string
            `{{paymentSessionId}}`.

            It was a placeholder.

            When this payment session endpoint successfully returned, Flute
            Checkout replaced the placeholder with the actual payment session
            identifier.


            Example:
            https://isv.example.com/payments/returnUrl/16143c97-07bc-448c-9807-924189311a66
          example: >-
            https://isv.example.com/payments/returnUrl/16143c97-07bc-448c-9807-924189311a66
        CheckoutUrl:
          type: string
          format: URL
          description: >
            For use with Flute Checkout only.


            Indicates the checkout URL.


            The checkout page is the URL of the Flute Checkout page.


            Example:
            https://public.flute.com/checkout/16143c97-07bc-448c-9807-924189311a66
          example: >-
            https://public.flute.com/checkout/16143c97-07bc-448c-9807-924189311a66
        createdAt:
          type: string
          format: date-time
          description: >
            For use with Flute Checkout only.


            Indicates the date and time (in an ISO 8601 date-time UTC format)
            the transaction was created.


            Example: 2026-01-19T14:27:02.767105Z
          example: '2026-01-19T14:27:02.767105Z'
        expiresAt:
          type: string
          format: date-time
          description: >
            For use with Flute Checkout only.


            Indicates the expiration date and time (in an ISO 8601 date-time UTC
            format) of the transaction.


            Example: 2026-01-19T14:27:02.767105Z
          example: '2026-01-19T14:27:02.767105Z'
        amount:
          type: number
          format: double
          description: |
            For use with Flute Checkout only.

            Indicates the payment amount.

            Example: 129.99
          example: 129.99
        currency:
          type: string
          nullable: true
          description: |
            For use with Flute Checkout only.

            Indicates the currency code (in ISO 4217 currency code).

            Example: USD
          example: USD
        status:
          type: string
          description: >
            For use with Flute Checkout only.


            Indicates the payment session status.


            Possible values:


            | Status    | Description |

            |-----------|-------------|

            | Created   | Payment session was initialized but not yet processed.
            |

            | Cancelled | Payment session was cancelled before completion.      
            |

            | Completed | Payment session was completed. Check transaction
            details to verify if the payment was approved or not. |

            | Failed    | Payment was attempted but did not succeed. A new
            session must be created for a new payment attempt.    |


            Example: Created
          example: Created
        paymentMethodTypes:
          type: array
          items:
            type: string
          description: |
            For use with Flute Checkout only.

            Indicates the payment method type name.

            Value values:

            | Name            | Notes                    |
            |-----------------| ------------------------ |
            | Card            | For credit or debit card |
            | Ach             |                          |

            Example: [ "Card", "Ach" ]
          example:
            - Card
            - Ach
        metadata:
          type: object
          nullable: true
          additionalProperties:
            type: string
            nullable: true
          description: >
            For use with Flute Checkout only.


            Specifies key-value pairings.


            This is an optional collection of key-value pairings to provide
            additional information for the checkout process.

            They are arbitrary values, often specific to the transaction.


            Content of the key-value pairs will be sanitized for security
            purposes.

            Maximum of 50 key-value pairings.

            Maximum 40 characters for the key name.

            Maximum 500 characters for the value.

            The maximum for the entire set of key-value pairings is 8Kb.


            Examples:<br>

            [ {"orderId": "9921"} ]<br>

            [ {"invoiceNumber": "INV-2026-001"} ]<br>
          example:
            - orderId: '9921'
            - invoiceNumber: INV-2026-001
      additionalProperties: false
    PaymentIntegrations.Contracts.Enums.PaymentSessionStatus:
      type: integer
      format: int32
      description: >
        Indicates the payment session status.


        Possible values:


        | Value | Status     | Description |

        | :---: | -----------|-------------|

        | 1     | Created    | Payment session was initialized but not yet
        processed. |

        | 2     | Cancelled  | Payment session was cancelled before completion.
        |

        | 3     | Completed  | Payment session was completed. Check transaction
        details to verify if the payment was approved or not. |

        | 4     | Failed     | Payment was attempted but did not succeed. A new
        session must be created for a new payment attempt. |


        Example: 3
      example: 3
    PaymentGateway.Contracts.TransactionSourceResponseDto:
      type: object
      properties:
        typeId:
          type: integer
          format: int32
          nullable: true
        type:
          type: string
          nullable: true
        id:
          type: string
          format: uuid
          nullable: true
        name:
          type: string
          nullable: true
        version:
          type: string
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails.History:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: |
            Indicates the transaction identifier.

            Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
          example: c7c15dd0-03e7-4e55-917c-54bedafba5e7
        transactionDateTime:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) of the
            invoice transaction.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        transactionAmount:
          type: number
          format: double
          nullable: true
        transactionTypeId:
          type: integer
          format: int32
          description: |
            Indicates the transaction type identifier.

            Possible values:

            | Type          | Value |
            |---------------|:-----:|
            | Authorization | 1     |
            | Sale          | 2     |
            | Capture       | 3     |
            | Void          | 4     |
            | Refund        | 5     |
            | Verify        | 6     |

            Example: 5
          example: 5
        transactionType:
          type: string
          nullable: true
          description: |
            Indicates the transaction type name.

            Possible values:

            | Value         | Type  |
            |---------------|:-----:|
            | Authorization | 1     |
            | Sale          | 2     |
            | Capture       | 3     |
            | Void          | 4     |
            | Refund        | 5     |
            | Verify        | 6     |

            Example: Refund
          example: Refund
        transactionStatusId:
          type: integer
          format: int32
        transactionStatus:
          type: string
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails:
      type: object
      description: Contains information about the processed transaction.
      properties:
        transactionReceiptUrl:
          type: string
          description: Indicates the direct link URL to the transaction receipt.
          nullable: true
        transactionReceiptShortUrl:
          type: string
          description: Indicates the shortened URL to access the transaction receipt.
          nullable: true
        source:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.TransactionSourceResponseDto
        transactionReceipt:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.TransactionReceiptDto
        id:
          type: string
          format: uuid
          description: |
            Indicates the transaction identifier.

            Example: 0e0034bd-028f-4809-b185-f4cca086eb33
          example: 0e0034bd-028f-4809-b185-f4cca086eb33
        paymentProcessorId:
          type: string
          format: uuid
          description: |
            Specifies the payment processor identifier.

            Example: 2059fcc1-5507-42be-8e4c-f4fcce245027
          example: 2059fcc1-5507-42be-8e4c-f4fcce245027
        date:
          type: string
          format: date-time
          nullable: true
          description: >
            Indicates the date of the transaction (in an ISO 8601 date-time UTC
            format).


            Examples: 2025-01-27T12:05:54.322587Z
          example: '2025-01-27T12:05:54.322587Z'
        amount:
          $ref: '#/components/schemas/PaymentGateway.Contracts.Amounts.AmountDto'
        currencyId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the currency identifier (in Flute currency code).

            This value is set to *1*.

            Example: 1
          example: 1
        currencyCode:
          type: string
          nullable: true
          description: |
            Indicates the currency (in ISO 4217 alpha-3 currency code format).

            Example: USD
          example: USD
        createdBy:
          type: string
          nullable: true
          description: |
            Indicates the creator of the transaction.
        merchant:
          type: string
          nullable: true
          description: |
            Indicates the merchant creating the transaction.
        merchantId:
          type: string
          format: uuid
          description: |
            Indicates the merchant identifier of the transaction.

            Example: fae7620d-ab02-4375-bc20-6ff326b917fd
          example: fae7620d-ab02-4375-bc20-6ff326b917fd
        processorId:
          type: string
          format: uuid
          description: |
            Indicates the processor identifier.

            Example: 5e9018ff-dbbb-4ff4-8cde-b10579a3fcd9
          example: 5e9018ff-dbbb-4ff4-8cde-b10579a3fcd9
        processor:
          type: string
          nullable: true
          description: >
            Indicates the payment processor.


            This is the system or company that handles the actual movement and
            authorization of payment transactions.


            Examples:<br>

            TSYS<br>

            Fiserv
          example: TSYS
        operationMode:
          type: string
          nullable: true
          description: |
            Indicates the operation mode.

            Possible values:

            | OperationMode | Id |
            |---------------|:--:|
            | PayNow        | 1  |
            | Subscription  | 2  |
        paymentMethodTypeId:
          type: integer
          format: int32
          description: |
            Indicates the payment method type identifier.

            Value values:

            | Id | Name                   |
            |:--:|------------------------|
            | 1  | Card (for credit card) |
            | 2  | ElectronicCheck        |

            Example: 2
          example: 2
        paymentMethodType:
          type: string
          nullable: true
          description: |
            Indicates the payment method type name.

            Value values:

            | Name            | Id | Notes                    |
            |-----------------|:--:| ------------------------ |
            | Card            | 1  | For credit or debit card |
            | ElectronicCheck | 2  |                          |

            Example: Card
          example: Card
        paymentMethodName:
          type: string
          nullable: true
          description: >
            Indicates the name of the payment method.


            This is a free-formed name that is convenient for the merchant to
            recognize.


            Example: Cafe Peppared
          example: Cafe Peppared
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        customerName:
          type: string
          nullable: true
        customerCompany:
          type: string
          nullable: true
          description: |
            Indicates the customer name.

            Example:
          example: Peppared Street Cafe
        customerPan:
          type: string
          nullable: true
          description: >
            Indicates customer’s PAN (primary account number).


            This is the payment card number.

            The value is masked except for a few numbers for additional
            security.


            Example: ************3655
          example: '************3655'
        customerEmail:
          type: string
          nullable: true
          description: |
            Indicates the customer's email.

            Example: peppared@example.com
          example: peppared@example.com
        customerPhone:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          nullable: true
          description: |
            Indicates the customer's phone number.

            Example: +14155552309
          example: '+14155552309'
        status:
          type: string
          nullable: true
          description: |
            Indicates the session status.

            Example: Processing
          example: Processing
        statusId:
          type: integer
          format: int32
          description: |
            Indicates the session status identifier.

            Example: 1
          example: 1
        responseCode:
          type: string
          nullable: true
          description: |
            Indicates a response code regarding the transaction.

            Example: 000
          example: '000'
        responseMessage:
          type: string
          nullable: true
          description: >
            Indicates the message for the response code regarding the
            transaction.
        responseDescription:
          type: string
          nullable: true
          description: |
            Indicates a free-formed description regarding the transaction.

            Example: Command Successful. Approved.
          example: Command Successful. Approved.
        avsResponseCode:
          type: string
          nullable: true
        availableStates:
          type: array
          items:
            type: string
          nullable: true
        refunded:
          type: boolean
          description: |
            Indicates the transaction was refunded.

            If `true`, transaction was refunded.<br>
            If `false`, transaction was not refunded.

            Example: true
          example: true
        cardType:
          type: string
          nullable: true
        typeId:
          type: integer
          format: int32
        type:
          type: string
          nullable: true
        creditDebitTypeId:
          type: integer
          format: int32
          nullable: true
          description: |
            Indicates the credit or debit type identifier.

            Possible values:

            | Int | Value   |
            |:---:|---------|
            | 1   | Credit  |
            | 2   | Debit   |
            | 3   | Unknown |
        creditDebitTypeType:
          type: string
          nullable: true
          description: |
            Indicates the credit or debit type.

            Possible values:

            | Value   | Int |
            |---------|:---:|
            | Credit  | 1   |
            | Debit   | 2   |
            | Unknown | 3   |
        authCode:
          type: string
          nullable: true
        mid:
          type: string
          nullable: true
          description: >
            Indicates the MID (merchant identifier) assigned to this
            transaction.


            Example: 43252511
          example: '43252511'
        tid:
          type: string
          nullable: true
          description: >
            Indicates the TID (terminal identifier) assigned to this
            transaction.


            Example: 8820432549239101
          example: '8820432549239101'
        referenceId:
          type: string
          nullable: true
        availableOperations:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentGateway.Contracts.Enums.TransactionOperation
          nullable: true
        avsResponse:
          $ref: >-
            #/components/schemas/PaymentGateway.Contracts.Transactions.AvsResponseDto
        histories:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails.History
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionIsvResponse:
      type: object
      properties:
        statusId:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Enums.PaymentSessionStatus
        status:
          type: string
          nullable: true
          readOnly: true
          description: >
            Indicates the payment session status.


            Possible values:


            | Status    | Value | Description |

            |-----------|:-----:|-------------|

            | Created   | 1     | Payment session was initialized but not yet
            processed. |

            | Cancelled | 2     | Payment session was cancelled before
            completion. |

            | Completed | 3     | Payment session was completed. Check
            transaction details to verify if the payment was approved or not. |

            | Failed    | 4     | Payment was attempted but did not succeed. A
            new session must be created for a new payment attempt. |


            Example: Completed
          example: Completed
        customerId:
          type: string
          format: uuid
          description: >
            Indicates the customer identifier.


            This was used when saving the payment method.<br>

            If this value was provided, the payment method was saved to the
            specified customer.<br>

            If this value was not provided, a new customer record was created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        mode:
          type: integer
          format: enum
          description: >
            Specifies the intent of the session.


            Defaults to Payment if omitted.


            | Value | Name            |
            Description                                   |

            |:-----:|-----------------|-----------------------------------------------|

            | 1     | Payment         | Standard payment
            session.                     |

            | 2     | SaveMethod      | Vault-only session to store a payment
            method. |

            | 3     | PaymentAndSave  | Charge the payment and save the
            method.       |


            Example: 2
          example: 2
        skipAddressVerification:
          type: boolean
          default: false
          description: >
            Indicates to bypass the AVS (address verification service) in the
            payment gateway.


            This value is applicable only to `Payment` and `PaymentAndSave` from
            `mode`.


            If `true`, bypasses AVS in the payment gateway.<br>

            If `false`, does not bypass AVS in the payment gateway.


            Example: true
          example: true
        referenceId:
          type: string
          nullable: true
          description: >
            Specifies an external transaction identifier for client-side
            tracking.


            Also used in duplicate control validation.

            A unique value allows similar transactions to process as distinct,
            bypassing duplicate blocking when needed.


            Example: 10001
          example: '10001'
        vaultedPaymentMethodId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates the identifier of the vaulted payment method when the
            session involves saving or using a stored payment method.


            Example: 990a65f4-519c-44f9-a615-fc9c7781190c
          example: 990a65f4-519c-44f9-a615-fc9c7781190c
        transactionDetails:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.PaymentSessions.Get.GetPaymentSessionTransactionDetails
      additionalProperties: false
    PaymentIntegrations.WebApi.Isv.Controllers.PingController.PingResponse:
      type: object
      description: >
        Indicates an object describing the response returned by the `GET
        /pay-int-api/ping` endpoint.
      properties:
        authenticated:
          type: boolean
          description: |
            Indicates the request is authenticated.

            If `true`, the request is authenticated.<br>
            If `false`, the request is not authenticated.

            Example: true
          example: true
        merchantId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates the identifier of the merchant.


            If a value is provided, the API key is valid and requests can be
            made.<br>

            If a value is omitted or null, the API key is not valid.

            It may mean that the API key is not associated with this merchant.

            Check that the API key, clientId, and client secret are correct.


            Example: 46063d32-10fa-44cb-b118-20ddd085ce3f
          example: 46063d32-10fa-44cb-b118-20ddd085ce3f
        clientId:
          type: string
          format: uuid
          nullable: true
          description: >
            Indicates the first value association with the API key.


            The second value association with the API key, the client secret, is
            never shown after the initial creation.


            Example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5
          example: 3b87fab4-5be4-44d3-9070-5f6ec1dfcbf5
      additionalProperties: false
    PaymentIntegrations.Contracts.Enums.QuickPaymentStatus:
      type: integer
      description: >
        Payment link status.


        Possible values:


        | Status ID | Status    | Description |

        | :-------: |-----------|-------------|

        | 1         | Active    | The link is active and can be used.       |

        | 2         | Inactive  | The link is inactive and cannot be used.  |

        | 3         | Expired   | The link is inactive by timing out.       |

        | 4         | Completed | The link is inactive by having been used
        successfully. |
      format: int32
    PaymentIntegrations.Contracts.QuickPayments.OneTime.GetPage.GetOneTimeQuickPaymentPageResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        customerName:
          type: string
          nullable: true
        amount:
          type: number
          format: double
        status:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus
        createdOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) when
            the one-time quick payment was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        expirationTime:
          type: string
          format: date-time
          nullable: true
        transactionId:
          type: string
          format: uuid
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.GetPage.GetIsvOneTimeQuickPaymentPageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.QuickPayments.OneTime.GetPage.GetOneTimeQuickPaymentPageResponseDto
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of one-time quick payments found.

            Example: 17
          example: 17
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentRequest:
      type: object
      properties:
        amount:
          type: number
          format: double
          minimum: 0
          exclusiveMinimum: true
          description: |
            Specifies the amount (in USD) of the one-time payment.

            Example: 45.99
          example: 45.99
        referenceId:
          type: string
          maximum: 100
          minimum: 0
          description: |
            Specifies the ReferenceId.

            Example: 10001
          example: '10001'
          nullable: true
        customerId:
          type: string
          format: uuid
          nullable: true
          description: |
            Specifies the customer identifier.

            Example: c9ae4972-b934-41aa-8e1a-1e5d8ad34bec
          example: c9ae4972-b934-41aa-8e1a-1e5d8ad34bec
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Create.CreateIsvOneTimeQuickPaymentResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >
            Indicates the payment reference link identifier, also known as the
            *quickPaymentId*.


            Example: c8c67f32-aca5-47c4-b10e-123086a43075
          example: c8c67f32-aca5-47c4-b10e-123086a43075
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.OneTime.Get.GetIsvOneTimeQuickPaymentResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        amount:
          type: number
          format: double
        referenceId:
          type: string
          nullable: true
        status:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus
        shortUrl:
          type: string
          nullable: true
        customerId:
          type: string
          format: uuid
          nullable: true
          description: >
            Specifies the customer identifier.


            This is used when saving the payment method.<br>

            If this value is provided, the payment method is saved to the
            specified customer.<br>

            If this value is not provided, a new customer record is created.


            Example: fd9198a4-eb6f-4620-9603-4f4638289de5
          example: fd9198a4-eb6f-4620-9603-4f4638289de5
        customerName:
          type: string
          nullable: true
        createdOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) when
            the quick payment was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.SmsNotification.SendIsvQuickPaymentSmsNotificationRequest:
      type: object
      properties:
        phoneNumber:
          type: string
          format: E.164
          maxLength: 20
          pattern: ^(null|\+\d{1,20})$
          nullable: true
          description: |
            Indicates the SMS phone number.

            Example: +14155552309
          example: '+14155552309'
        customerConsent:
          type: boolean
          description: |
            Indicates the customer has consented to receiving the SMS.

            If `true`, the customer has consented to receiving the SMS.<br>
            If `false`, the customer has not consented to receiving the SMS.

            Example: true
          example: true
      additionalProperties: false
    PaymentIntegrations.Contracts.QuickPayments.Reusable.GetPage.GetReusableQuickPaymentPageResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        amount:
          type: number
          format: double
        status:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus
        createdOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) when
            the reusable quick payment was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
        totalTransactionsAmount:
          type: number
          format: double
        shortUrl:
          type: string
          nullable: true
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.GetPage.GetIsvReusableQuickPaymentPageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentIntegrations.Contracts.QuickPayments.Reusable.GetPage.GetReusableQuickPaymentPageResponseDto
          nullable: true
        total:
          type: integer
          format: int32
          description: |
            Indicates the total number of re-usable quick payments found.

            Example: 5
          example: 5
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.Create.CreateIsvReusableQuickPaymentRequest:
      type: object
      properties:
        amount:
          type: number
          format: double
          minimum: 0
          exclusiveMinimum: true
          description: |
            Specifies the amount (in USD) of the one-time payment.

            Example: 45.99
          example: 45.99
      additionalProperties: false
    PaymentIntegrations.Contracts.PublicApi.Isv.QuickPayments.Reusable.Get.GetIsvReusableQuickPaymentResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        amount:
          type: number
          format: double
        status:
          $ref: >-
            #/components/schemas/PaymentIntegrations.Contracts.Enums.QuickPaymentStatus
        shortUrl:
          type: string
          nullable: true
        totalTransactionsAmount:
          type: number
          format: double
        totalTransactionsCount:
          type: integer
          format: int32
        createdOn:
          type: string
          format: date-time
          description: >
            Indicates the date-time (in an ISO 8601 date-time UTC format) when
            the reusable quick payment was created.


            Examples: 2026-02-19T20:24:52.934Z
          example: '2026-02-19T20:24:52.934Z'
      additionalProperties: false
  responses:
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/AspNet.Swagger.Examples.ValidationExceptionExample
          example:
            errors:
              Email:
                - '''Email'' is not a valid email address.'
            details: >
              Validation failed: -- Email: 'Email' is not a valid email address.
              Severity: Error
            statusCode: 400
            source: <Service>
            exceptionType: FluentValidation.ValidationException
            correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fef
            entityId: null
            errorCode: null
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CommonExceptionExample'
          example:
            errors:
              BearerTokenError:
                - >-
                  invalid_token, error_description='The token expired at
                  '06/29/2026 21:08:02''
            details: One or more validation errors occurred.
            statusCode: 401
            source: <Service>
            exceptionType: UnauthorizedException
            correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
            entityId: null
            errorCode: V0000
            title: Validation failed
            cause: One or more fields failed validation rules.
            resolution: Review the errors and correct the invalid fields.
            documentationUrl: https://developer.risewithaurora.com/
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
          example:
            details: >
              No identifier found with 'b31fbe9f-eebb-45ce-9cae-92265389f471'
              with type=<Service>.DataAccess.Entities.<Model>Entity
            statusCode: 404
            source: <Service>
            exceptionType: Exceptions.NotFoundException
            correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fee
            entityId: null
            errorCode: null
    '500':
      description: Internal Error
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/AspNet.Swagger.Examples.NotFoundExceptionExample
          example:
            details: >
              No identifier found with 'b31fbe9f-eebb-45ce-9cae-92265389f47f',
              type='<Service>.DataAccess.Entities.<Model>Entity'
            statusCode: 500
            source: <Service>
            exceptionType: Exceptions.NotFoundException
            correlationId: aa6cfcd0-0295-4a4c-b074-8c901f114fef
            entityId: null
            errorCode: null
  parameters:
    transaction_id:
      name: transactionId
      in: path
      required: true
      description: >
        Specifies the ACH (automated clearing house) transaction identifier.


        This value is returned as `transactionId` from either of the following
        endpoints:

        * `POST /pay-api/v1/transactions/ach/payment`

        * `GET /pay-api/v1/transactions/ach/payment/credit`
      schema:
        type: string
        format: uuid
        example: 004db5a8-a153-4334-a0b4-1aa22fbffb3e
    orderby:
      name: orderBy
      in: query
      description: |
        Specifies the field the results get ordered by.

        The sort order is specified by the `asc` value.

        Example: contactName
      schema:
        type: string
    asc:
      name: asc
      in: query
      description: |
        Specifies the sort order is ascending.

        The sort field is specified by the `orderBy` value.

        If `true`, the sort order is ascending.<br>
        If `false`, the sort order is descending.

        Example: true
      schema:
        type: boolean
        default: true
    page:
      name: page
      in: query
      description: >
        Specifies the page number of the returned search results.


        A page is considered each set of the `pageSize` value.


        The maximum page value is the `pageSize` divided by the `total` count
        rounded up.

        The count is zero-based.

        For example, if `pageSize` is 50 and the `total` is 130, there are three
        pages.

        The maximum `page` value is 2.


        Values above the maximum page value will complete successfully but not
        return any items.


        Example: 0
      schema:
        type: integer
        format: int32
        default: 0
    pagesize:
      name: pageSize
      in: query
      description: >
        Specifies the number of items for each page of the returned search
        results.


        A page is considered each set of the `pageSize` value.


        The maximum page value is the `pageSize` divided by the `total` count
        rounded up.

        The count is zero-based.

        For example, if `pageSize` is 50 and the `total` is 130, there are three
        pages.

        The maximum `page` value is 2.


        Example: 50
      schema:
        type: integer
        format: int32
        default: 15
    quickpaymentid:
      name: quickPaymentId
      in: path
      description: |
        Specifies the payment link identifier.

        This value is returned from either:
        * `POST /pay-int-api/quick-payments/one-time`
        * `POST /pay-int-api/quick-payments/reusable`
      required: true
      schema:
        type: string
        format: uuid
        example: 0423617a-2004-4516-935d-e5ad4bbbe93e
