> ## Documentation Index
> Fetch the complete documentation index at: https://developer.forebit.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List payments

> Fetch a paginated set of payments for the business. Filter by date range, status, coin type, amount bounds, or free-text search. The total count is returned in the X-Pagination-Total response header.



## OpenAPI

````yaml https://prod-payments-api.forebit.io/openapi.json get /v1/businesses/{businessId}/payments
openapi: 3.0.1
info:
  title: Forebit API
  description: >-
    Accept crypto payments across Bitcoin, Ethereum, Tron, and other networks.
    Create payments, manage businesses, and track transactions through a single
    unified interface.
  termsOfService: https://forebit.io/terms
  contact:
    name: Forebit Team
    email: support@forebit.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: v1.0.0
servers:
  - url: https://prod-payments-api.forebit.io/
security:
  - Bearer: []
tags:
  - name: Payments
    description: Create, list, and inspect crypto payments for a business.
  - name: Payments
    description: Payments
paths:
  /v1/businesses/{businessId}/payments:
    get:
      tags:
        - Payments
      summary: List payments
      description: >-
        Fetch a paginated set of payments for the business. Filter by date
        range, status, coin type, amount bounds, or free-text search. The total
        count is returned in the X-Pagination-Total response header.
      operationId: GetPayments
      parameters:
        - name: businessId
          in: path
          description: The target business ID.
          required: true
          schema:
            type: integer
            format: int64
        - name: PageNumber
          in: query
          schema:
            type: integer
            format: int32
        - name: PageSize
          in: query
          schema:
            type: integer
            format: int32
        - name: fromTime
          in: query
          description: Start of the date range filter.
          schema:
            type: string
            format: date-time
        - name: toTime
          in: query
          description: End of the date range filter.
          schema:
            type: string
            format: date-time
        - name: statuses
          in: query
          description: Narrow results to these statuses.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/PaymentStatus'
        - name: cryptoCoins
          in: query
          description: Narrow results to these coins.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/CryptoCoinName'
        - name: fromAmount
          in: query
          description: Minimum amount threshold.
          schema:
            type: number
            format: double
        - name: toAmount
          in: query
          description: Maximum amount threshold.
          schema:
            type: number
            format: double
        - name: searchString
          in: query
          description: Free-text match against description, name, note, or customer email.
          schema:
            type: string
        - name: onBehalfOfBusinessId
          in: query
          description: Scope to a specific on-behalf-of business.
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Payments returned.
          content:
            text/plain:
              schema:
                $ref: >-
                  #/components/schemas/BaseResponseOfListOfPaymentInListForGetPaymentsResponse
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BaseResponseOfListOfPaymentInListForGetPaymentsResponse
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/BaseResponseOfListOfPaymentInListForGetPaymentsResponse
        '401':
          description: Missing or invalid authentication token.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Insufficient permissions for this business.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    PaymentStatus:
      enum:
        - AWAITING_PAYMENT
        - PENDING
        - PROCESSING
        - UNDERPAID
        - COMPLETED
        - FAILED
        - CANCELLED
        - EXPIRED
      type: string
    CryptoCoinName:
      enum:
        - BITCOIN
        - ETHEREUM
        - LITECOIN
        - BITCOIN_CASH
        - ETH_USD_COIN
        - ETH_TETHER
        - MONERO
        - BNB
        - ETH_BUSD
        - ETH_MATIC
        - ETH_SHIBA_INU
        - ETH_APE_COIN
        - ETH_CRONOS
        - ETH_DAI
        - ETH_UNISWAP
        - TRON
        - TRX_TETHER
        - TRX_USD_C
        - UNKNOWN
        - CONTRACT_ERC20_ETH
        - CONTRACT_ERC20_USDT
        - CONTRACT_ERC20_USDC
        - CONTRACT_TRC20_TRX
        - CONTRACT_TRC20_USDT
        - CONTRACT_TRC20_USDC
        - SOLANA
        - SOL_TETHER
        - SOL_USD_COIN
        - TON
      type: string
    BaseResponseOfListOfPaymentInListForGetPaymentsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PaymentInListForGetPaymentsResponse'
          nullable: true
        message:
          type: string
          nullable: true
        errors:
          type: array
          items:
            type: string
          nullable: true
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    PaymentInListForGetPaymentsResponse:
      required:
        - createdAt
        - currency
        - endAmount
        - id
        - status
      type: object
      properties:
        id:
          type: string
          format: uuid
        endAmount:
          type: number
          format: double
        currency:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        customerEmail:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/PaymentStatus'
        paymentMethod:
          type: string
          nullable: true
        selectedPaymentMethod:
          $ref: '#/components/schemas/PaymentMethod'
        forebitCryptoCharge:
          $ref: '#/components/schemas/ForebitCryptoChargeForPaymentInListResponse'
        contractCharge:
          $ref: '#/components/schemas/ContractChargeForPaymentInListResponse'
      additionalProperties: false
    PaymentMethod:
      enum:
        - FOREBIT_CRYPTO
        - CONTRACT_CRYPTO
        - CONTRACT_TRX
        - NONE
      type: string
    ForebitCryptoChargeForPaymentInListResponse:
      type: object
      properties:
        amount:
          type: number
          format: double
        coinName:
          type: string
          nullable: true
        exchangeRate:
          type: number
          format: double
        isUnderpaid:
          type: boolean
        address:
          type: string
          nullable: true
        network:
          $ref: '#/components/schemas/Network'
      additionalProperties: false
    ContractChargeForPaymentInListResponse:
      type: object
      properties:
        amount:
          type: number
          format: double
        coinName:
          type: string
          nullable: true
        exchangeRate:
          type: number
          format: double
        isUnderpaid:
          type: boolean
        address:
          type: string
          nullable: true
      additionalProperties: false
    Network:
      enum:
        - ETHEREUM
        - TRON
        - BTC
        - LTC
        - SOLANA
      type: string
  securitySchemes:
    Bearer:
      type: http
      description: Pass your JWT token in the Authorization header as a Bearer token.
      scheme: bearer
      bearerFormat: JWT

````