Skip to main content
GET
List Payments
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

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

Response

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