Skip to main content
GET
/
payments
/
tsq
/
{reference}
Query Payment Status
curl --request GET \
  --url https://api.usepooler.com/payments/tsq/{reference} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "<string>",
    "status": "pending",
    "amount": "<string>",
    "currency": "<string>",
    "description": "<string>",
    "type": "<string>",
    "sub_type": "<string>",
    "category": "<string>",
    "transaction_date": "2023-11-07T05:31:56Z",
    "tags": "<string>",
    "is_reversed": true,
    "is_completed": true,
    "channel": "<string>",
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}
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

​
reference
string
required
Payment reference number (e.g., “PLR-55b8081c”)

​
Response

​
data
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

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Include your API key in the Authorization header as: Bearer {your_api_key}

Path Parameters

​
reference
string
required

Payment reference number

Response

200 - application/json

Payment status retrieved successfully

​
success
boolean
​
message
string
​
stan
string<uuid>
​
data
object