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

# Get payment list



## OpenAPI

````yaml /payment.openapi.json post /api/data-query
openapi: 3.1.0
info:
  title: payment hub
  description: |
    Focused OpenAPI 3.1 contract for the **launch-payment** endpoint
    (`POST /api/transactions`). The request body is polymorphic on
    `paymentGatewayType`; each gateway sub-schema documents the gateway-specific
    fields. Highlights:

      * `onlineScenario=true` → customer-initiated, Hosted-Checkout / redirect flow
      * `onlineScenario=false` → merchant-initiated debit using a previously
        stored payment method (only valid on gateways that support offline)
      * `supportOfflineScenario` (Stripe / PayerMax only) — when `true` and
        `onlineScenario=true`, the gateway is instructed to remember the card
        so a future off-session (merchant-initiated) charge can succeed.
  version: 1.0.0
  summary: ''
servers:
  - url: https://sbx.api.easybilling.cloud/payment-hub
    description: SBX
  - url: https://api.easybilling.cloud/payment-hub
    description: Production-AWS
security:
  - token: []
tags:
  - name: Payment Hub
paths:
  /api/data-query:
    post:
      tags:
        - Payment Hub
      summary: Get payment list
      parameters:
        - name: size
          in: query
          description: ''
          required: false
          schema:
            type: integer
            default: 20
            minimum: 20
            maximum: 500
        - name: page
          in: query
          description: ''
          required: false
          schema:
            type: integer
        - name: trace-id
          in: header
          description: ''
          required: true
          example: '{{$string.uuid}}'
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                startDate:
                  type: string
                  format: date
                endDate:
                  type: string
                  format: date
                queryObject:
                  type: string
                  enum:
                    - payment-query-list
                filters:
                  type: array
                  items:
                    type: object
                    properties:
                      fieldName:
                        type: string
                        enum:
                          - transactionId
                          - customerIdentifier
                          - paymentGatewayType
                          - status
                      fieldValues:
                        type: array
                        items:
                          type: object
                          properties: {}
              required:
                - queryObject
            example:
              startDate: '2026-01-01'
              endDate: '2027-01-01'
              queryObject: payment-query-list
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  content:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          title: Unique ID in the payment table
                          description: id of this record
                        gatewayLink:
                          type: string
                          title: Gateway payment link
                          description: >-
                            This link can be used to initiate payment on the
                            corresponding payment platform
                        customerIdentifier:
                          type:
                            - string
                            - 'null'
                          title: Customer identifier
                          description: Can be phone number/email/openId, etc.
                        transactionId:
                          type: string
                          title: Transaction ID
                          description: payment transaction id
                        description:
                          type: string
                          title: Transaction information
                          description: Description information for initiating payment
                        amount:
                          type: string
                          title: Payment amount
                          description: Payment amount
                        currency:
                          type: string
                          title: Currency unit
                          description: Currency code, following ISO-4217 standard
                        paymentGateway:
                          type: string
                          title: Payment gateway
                          description: >-
                            If payment is completed, returns the earliest
                            successfully paid gateway
                          enum:
                            - stripe-connect
                            - payer-max-isv
                        datetime:
                          type: string
                          title: Creation time
                          description: Creation time
                        status:
                          type: string
                          title: Payment status
                          enum:
                            - pending
                            - processing
                            - succeeded
                            - failed
                            - expired
                            - closed
                            - refunded
                        refundedAmount:
                          type: string
                          title: Refund amount
                          description: Refund amount
                      required:
                        - gatewayLink
                        - id
                  number:
                    type: integer
                    title: Page number
                  size:
                    type: integer
                    title: Number of items per page
                  totalElements:
                    type: integer
                    title: Total number of items
                  totalPages:
                    type: integer
                    title: Total number of pages
                  last:
                    type: boolean
                  first:
                    type: boolean
                  numberOfElements:
                    type: integer
                  empty:
                    type: boolean
                  sort:
                    type: object
                    properties:
                      empty:
                        type: boolean
                      sorted:
                        type: boolean
                      unsorted:
                        type: boolean
                    required:
                      - empty
                      - sorted
                      - unsorted
                  pageable:
                    type: object
                    properties:
                      pageNumber:
                        type: integer
                      pageSize:
                        type: integer
                      offset:
                        type: integer
                      paged:
                        type: boolean
                      unpaged:
                        type: boolean
                      sort:
                        type: object
                        properties:
                          empty:
                            type: boolean
                          sorted:
                            type: boolean
                          unsorted:
                            type: boolean
                        required:
                          - empty
                          - sorted
                          - unsorted
                    required:
                      - pageNumber
                      - pageSize
                      - sort
                      - offset
                      - paged
                      - unpaged
                required:
                  - content
                  - number
                  - size
                  - totalElements
                  - totalPages
                  - last
                  - first
                  - pageable
                  - sort
                  - numberOfElements
                  - empty
              example:
                records:
                  - id: 48157f1b-f5ec-4f93-bbc0-8473e275bc30
                    gatewayLink: >-
                      https://checkout.stripe.com/c/pay/cs_test_a1YyW0yQcqjpQG3TKUz96ONYWW1AeFzCh8Zxdlxe17fHuvjs0D5tojc0Eh#fidnandhYHdWcXxpYCc%2FJ2FgY2RwaXEnKSd2cXdsdWBEZmZqcGtxJz8nZGZmcVo0Vm9fb39DUjVMUkdgNW1OJyknZHVsTmB8Jz8ndW5acWB2cVowNFZLdH1UNlNIR3NdQ0BHZmo0cUBtNjBEYmJGdHUzNTxAdUR1TERHZEhmS2pBNX9OajJcUDcwVWlucz1sV3NBdXVdcT1BV09LZHNcUGwydUpWNkhPaWBQVzU1fUJhU3RgQWInKSdjd2poVmB3c2B3Jz9xd3BgKSdnZGZuYndqcGthRmppancnPycmY2NjY2NjJyknaWR8anBxUXx1YCc%2FJ3Zsa2JpYFpscWBoJyknYGtkZ2lgVWlkZmBtamlhYHd2Jz9xd3BgeCUl
                    email: null
                    transactionId: ui939sl09ie32uo23we32rtkki
                    description: test
                    amount: '10000'
                    currency: USD
                    paymentGateway: STRIPE_CONNECT
                    date: '2026-01-27T09:43:09Z'
                    status: PROCESSING
                    refundedAmount: '0'
                pageNum: 1
                pageSize: 2
                total: 1
                pages: 1
                hasNext: false
                hasPrev: false
          headers: {}
      deprecated: false
      security:
        - token: []
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````