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

# List transactions

> Returns transactions matching the supplied filters. Supports the standard query envelope for filtering (including `metadata.<key>`), sorting, and pagination.



## OpenAPI

````yaml /openapi.json post /v1/query/transactions
openapi: 3.0.0
info:
  title: Jupico - OpenAPI 3.0
  description: >-
    The Jupico API lets Service Providers onboard merchants, process card and
    eCheck (ACH) payments, run hosted payment pages, manage recurring billing,
    send payouts, and query every resource. All endpoints use HTTPS with Basic
    authentication and accept and return JSON. Endpoints are grouped by
    workflow: onboard merchants first, then accept payments, then move funds and
    report.
  termsOfService: https://help.jupico.com/references-and-resources/legal
  contact:
    email: support@jupico.com
  license:
    name: Jupico License
    url: https://jupico.com
  version: 1.0.5
servers:
  - url: https://sandbox-platform.jupico.com
security:
  - basicAuth: []
tags:
  - name: Status
    description: Health check for the Jupico API.
  - name: Onboarding Invites
    description: >-
      Create and send invites that onboard merchants through the Jupico-hosted
      flow, with optional pre-filled identity, fees, and payout bank account
      data.
  - name: Provisioning
    description: >-
      Onboard merchants from your own UI. Collect onboarding data and submit it
      through the provisioning chain: applicant → application → submerchant.
  - name: Session
    description: >-
      Create browser authorization sessions for the Jupico web components, so
      card and bank account data is tokenized client-side and never touches your
      servers.
  - name: Tokenization
    description: >-
      Convert one-time tokens from the web components into permanent Jupico
      tokens, or tokenize raw card data if your systems are PCI DSS compliant.
  - name: Customer
    description: >-
      Create and manage customer records that payments, subscriptions,
      installments, and invoices link to.
  - name: Card Transactions
    description: >-
      Process credit and debit card transactions using tokenized card data:
      sale, authorization, capture, void, refund, and rollback.
  - name: eCheck Transactions
    description: >-
      Debit customer bank accounts via eCheck (ACH): sale, void, refund,
      rollback, and bank account tokenization.
  - name: Checkouts
    description: >-
      Hosted checkout sessions where customers complete payment on a
      Jupico-hosted page.
  - name: Payment Links
    description: >-
      Shareable links that open a Jupico-hosted payment page — no integration
      code needed at the point of sharing.
  - name: Invoices
    description: Create and email invoices that customers pay online.
  - name: Subscriptions
    description: >-
      Recurring billing. Plans define billing schedules and pricing models;
      subscriptions enroll customers against a stored payment token.
  - name: Installments
    description: Split a fixed total into scheduled payments with an optional deposit.
  - name: Payouts
    description: >-
      Send funds from a submerchant's available balance to a tokenized bank
      account with on-demand payout instructions.
  - name: Query
    description: >-
      Search and report across every resource: transactions, merchants,
      settlements, balances, disputes, fees, and more. All query endpoints
      accept the same filter, sort, and pagination envelope — see the Query
      Capabilities guide.
paths:
  /v1/query/transactions:
    post:
      tags:
        - Query
      summary: List transactions
      description: >-
        Returns transactions matching the supplied filters. Supports the
        standard query envelope for filtering (including `metadata.<key>`),
        sorting, and pagination.
      operationId: Query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                processing[batchDate]:
                  type: string
                  format: date
                  description: The batch processing date
                metadata.test:
                  type: string
                  example: test
                  description: >-
                    Example metadata filter. Filter on any metadata key as
                    `metadata.<key>`.
      responses:
        '200':
          $ref: '#/components/responses/transactionQuery'
      security:
        - basicAuth: []
components:
  responses:
    transactionQuery:
      description: Successful eCheckSale
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: >-
                  Whether the request was processed successfully. Declines
                  return HTTP 200 with `success: false`.
              message:
                type: string
                description: Human-readable result message.
              code:
                type: string
                description: Machine-readable result code. See the Error Codes reference.
              data:
                type: array
                items:
                  type: object
                  properties:
                    review:
                      type: object
                      properties:
                        enabled:
                          type: boolean
                          description: Whether this setting is enabled.
                        logs:
                          type: array
                          items:
                            type: string
                          description: Event log entries.
                      description: Risk review details for the transaction.
                    billing:
                      type: object
                      properties:
                        address:
                          type: string
                          description: Street address, including number.
                        city:
                          type: string
                          description: City name.
                        zipCode:
                          type: string
                          description: ZIP or postal code.
                        state:
                          type: string
                          description: Two-letter US state code.
                        email:
                          type: string
                          description: Email address of the payer.
                        name:
                          type: string
                          description: Full name of the payer.
                        phone:
                          type: string
                          description: Phone number of the payer.
                      description: Billing contact and address details for the payer.
                    shipping:
                      type: object
                      properties:
                        address:
                          type: string
                          description: Street address, including number.
                        city:
                          type: string
                          description: City name.
                        zipCode:
                          type: string
                          description: ZIP or postal code.
                        state:
                          type: string
                          description: Two-letter US state code.
                        email:
                          type: string
                          description: Email address of the recipient.
                        name:
                          type: string
                          description: Name of the recipient.
                        phone:
                          type: string
                          description: Phone number of the recipient.
                      description: Shipping contact and address details for the order.
                    processing:
                      type: object
                      properties:
                        fees:
                          type: object
                          properties:
                            applied:
                              type: boolean
                              description: Whether the fee was applied.
                          description: >-
                            Fee configuration. Overrides values from the fees
                            template.
                        chargebacks:
                          type: array
                          items:
                            type: string
                          description: Chargebacks linked to this transaction.
                        logs:
                          type: array
                          items:
                            type: object
                            properties:
                              status:
                                type: string
                                description: Current status.
                              createdAt:
                                type: string
                                description: >-
                                  Timestamp when the object was created (ISO
                                  8601).
                          description: Event log entries.
                        status:
                          type: string
                          description: Current status.
                        updatedAt:
                          type: string
                          description: >-
                            Timestamp when the object was last updated (ISO
                            8601).
                      description: >-
                        Processing details, including fees and batch
                        information.
                    paymentMethod:
                      type: object
                      properties:
                        cc:
                          type: object
                          properties:
                            card:
                              type: object
                              properties:
                                last4Digits:
                                  type: string
                                  description: Last 4 digits of the card number.
                                expirationYear:
                                  type: string
                                  description: Two-digit expiration year.
                                expirationMonth:
                                  type: string
                                  description: Two-digit expiration month (01-12).
                                logo:
                                  type: string
                                  description: Card brand logo identifier.
                              description: Card details.
                          description: Card payment method details.
                        eCheck:
                          type: object
                          properties:
                            accountType:
                              type: string
                              description: Bank account type, such as `checking`.
                            routingNumber:
                              type: string
                              description: 9-digit ABA routing number.
                            accountNumberLast4:
                              type: string
                              description: Last 4 digits of the bank account number.
                            checkNumber:
                              type: string
                              description: Check number to record with this debit.
                            checkType:
                              type: string
                              description: Type of check used for the debit.
                            bankAccToken:
                              type: string
                              description: Token of the bank account.
                          description: eCheck (ACH) acceptance settings.
                      description: Details of the payment method used.
                    amount:
                      type: number
                      description: The amount of the transaction.
                    balanceAmount:
                      type: number
                      description: >-
                        Remaining balance on the transaction after captures,
                        refunds, and voids.
                    voided:
                      type: boolean
                      description: Whether the transaction has been voided.
                    taxAmount:
                      type: number
                      description: Sales tax portion of the amount.
                    status:
                      type: string
                      description: Current status.
                    transactionId:
                      type: string
                      description: Unique identifier of the original transaction.
                    operation:
                      type: string
                      description: >-
                        Transaction operation type (for example, sale,
                        authorization, refund).
                    subMerchantId:
                      type: string
                      description: Unique identifier of the submerchant.
                    customerId:
                      type: string
                      description: Unique identifier of the customer.
                    parentId:
                      type: string
                      description: >-
                        Identifier of the parent transaction (for example, the
                        authorization behind a capture).
                    referenceNumber:
                      type: string
                      description: Processor reference number for the transaction.
                    txDate:
                      type: string
                      description: Date and time of the transaction (ISO 8601).
                    description:
                      type: string
                      description: Free-text description.
                    approvalNumber:
                      type: number
                      description: Approval code returned by the issuing bank.
                    createdAt:
                      type: string
                      description: Timestamp when the object was created (ISO 8601).
                    feeId:
                      type: string
                      description: Identifier of the fee record for this transaction.
                description: The response payload.
              count:
                type: number
                description: Number of records.
              query:
                type: object
                properties:
                  criteria:
                    type: object
                    properties:
                      transactionId:
                        type: number
                        description: Unique identifier of the original transaction.
                    description: Filter criteria applied, keyed by field path.
                  options:
                    type: object
                    description: 'Query options: pagination, sorting, and field projection.'
                description: Echo of the query envelope that produced this result.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````