Skip to main content
GET
/
payments
/
{id}
Retrieve Payment
curl --request GET \
  --url https://api.usepooler.com/payments/{id} \
  --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"
  }
}
Retrieve detailed information about a specific payment transaction by its ID.

Overview

This endpoint returns comprehensive details about a single payment transaction, including all metadata, status information, and transaction history.

Path Parameters

id
string
required
Payment transaction UUID

Response

data
object
Complete payment transaction object including:
  • id: Payment transaction ID
  • reference: Payment reference number
  • amount: Payment amount
  • currency: Currency code
  • description: Payment description
  • status: Current payment status
  • type: Transaction type (debit/credit)
  • sub_type: Transaction sub-type
  • category: Transaction category
  • sub_category: Transaction sub-category
  • channel: Payment channel used
  • tags: Transaction tags
  • notes: Additional notes
  • is_reversed: Whether payment was reversed
  • is_completed: Whether payment is completed
  • transaction_date: When transaction occurred
  • created_at: Creation timestamp
  • updated_at: Last update timestamp

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Payment transaction ID

Response

200 - application/json

Payment retrieved successfully

success
boolean
message
string
stan
string<uuid>
data
object