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

# Query Payment Status

> Query the status of a payment transaction using its reference number.

Query the status of a payment transaction using its reference number. This is useful for checking payment status without knowing the payment ID.

## Overview

This endpoint allows you to retrieve payment information using the payment reference number. It's particularly useful for transaction status queries (TSQ) when you only have the reference.

## Path Parameters

<ParamField path="reference" type="string" required>
  Payment reference number (e.g., "PLR-55b8081c")
</ParamField>

## Response

<ResponseField name="data" type="object">
  Payment transaction details including:

  * `id`: Payment transaction ID
  * `reference`: Payment reference
  * `status`: Payment status (pending, completed, failed)
  * `amount`: Payment amount
  * `currency`: Currency code
  * `description`: Payment description
  * `is_completed`: Whether payment is completed
  * `is_reversed`: Whether payment was reversed
  * `transaction_date`: When the transaction occurred
  * `created_at`: When the payment was created
  * `updated_at`: When the payment was last updated
</ResponseField>


## OpenAPI

````yaml GET /payments/tsq/{reference}
openapi: 3.0.0
info:
  title: Pooler Developer API
  description: >-
    Comprehensive API documentation for Pooler payment and financial services
    platform
  version: 1.0.0
servers:
  - url: https://api.usepooler.com
    description: Production server
  - url: https://sandbox.usepooler.com
    description: Sandbox server
security:
  - bearerAuth: []
paths:
  /payments/tsq/{reference}:
    get:
      tags:
        - Payments
      summary: Query Payment Status
      description: Query the status of a payment transaction using its reference number.
      operationId: queryPaymentStatus
      parameters:
        - name: reference
          in: path
          required: true
          description: Payment reference number
          schema:
            type: string
      responses:
        '200':
          description: Payment status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
components:
  schemas:
    PaymentResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        stan:
          type: string
          format: uuid
        data:
          $ref: '#/components/schemas/Payment'
    Payment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        reference:
          type: string
        status:
          type: string
          enum:
            - pending
            - completed
            - failed
        amount:
          type: string
        currency:
          type: string
        description:
          type: string
        type:
          type: string
        sub_type:
          type: string
        category:
          type: string
        transaction_date:
          type: string
          format: date-time
        tags:
          type: string
        is_reversed:
          type: boolean
        is_completed:
          type: boolean
        channel:
          type: string
        notes:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token authentication. Include your API key in the Authorization
        header as: Bearer {your_api_key}

````