Skip to main content
GET
/
payments
List Payments
curl --request GET \
  --url https://api.usepooler.com/payments \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "total_pages": 123,
    "current_page": 123,
    "total_records": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "items": [
      {
        "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 a paginated list of all payment transactions for your account. This endpoint allows you to view your payment history with filtering and pagination.

​
Overview

This endpoint returns a paginated list of all payment transactions associated with your account, sorted by creation date (newest first).

​
Query Parameters

​
page
integer
Page number for pagination (default: 1)
​
per_page
integer
Number of items per page (default: 20)

​
Response

​
data
object
Paginated response containing:
  • total_pages: Total number of pages
  • current_page: Current page number
  • total_records: Total number of payment records
  • next_page: URL for next page (empty if last page)
  • previous_page: URL for previous page (empty if first page)
  • items: Array of payment objects
​
data.items[]
object
Each payment object includes:
  • id: Payment transaction ID
  • reference: Payment reference
  • amount: Payment amount
  • currency: Currency code
  • status: Payment status
  • type: Transaction type (debit/credit)
  • category: Transaction category
  • channel: Payment channel
  • is_completed: Completion status
  • transaction_date: Transaction timestamp

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:1

Page number for pagination

​
per_page
integer
default:20

Number of items per page

Response

200 - application/json

Payments retrieved successfully

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