GET
/
payments
List payments
curl --request GET \
  --url https://api.simiz.io/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "token": "pay_abc123xyz789",
      "amount": 5000,
      "currency": "XAF",
      "status": "COMPLETED",
      "paymentMethod": "ORANGE_MONEY",
      "createdAt": "2024-01-15T10:30:00Z",
      "completedAt": "2024-01-15T10:31:45Z"
    }
  ],
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Use your Simiz API key as the Bearer token. Keys starting with smz_test_sk_ target sandbox, smz_live_sk_ target production.

Query Parameters

​
limit
integer
default:20

Items per page (1–100, default: 20)

Required range: 1 <= x <= 100
​
starting_after
string

Cursor for forward pagination. Pass the ID of the last item from the previous page.

​
ending_before
string

Cursor for backward pagination. Pass the ID of the first item from the previous page.

​
page
integer
default:1

Page number for offset pagination (ignored if cursor is provided)

Required range: x >= 1
​
status
enum<string>

Filter by transaction status Transaction lifecycle:

  • PENDING — Awaiting payer confirmation
  • PROCESSING — Payment being processed by provider
  • COMPLETED — Payment received successfully
  • FAILED — Payment failed
  • CANCELLED — Cancelled by merchant or payer
  • EXPIRED — Payer did not confirm in time
  • REFUNDED — Fully refunded
  • PARTIALLY_REFUNDED — Partially refunded
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED,
EXPIRED,
REFUNDED,
PARTIALLY_REFUNDED
​
paymentMethod
enum<string>

Filter by payment method Payment methods supported (backend Prisma enum):

  • ORANGE_MONEY — Orange Money
  • MTN_MOMO — MTN Mobile Money
  • UNKNOWN — Fallback / not yet determined
Available options:
ORANGE_MONEY,
MTN_MOMO,
UNKNOWN
​
search
string

Search by reference, token, phone, or name

​
minAmount
number

Minimum amount filter

Required range: x >= 0
​
maxAmount
number

Maximum amount filter

Required range: x >= 0
​
startDate
string<date-time>

Start date filter (ISO 8601)

​
endDate
string<date-time>

End date filter (ISO 8601)

​
currency
enum<string>

Filter by currency

Available options:
XAF,
XOF
​
expand[]
enum<string>[]

Expand inline relations (e.g. expand[]=customer&expand[]=refunds)

Available options:
customer,
project,
refunds,
events

Response

Paginated list of payments

​
data
object[]
​
has_more
boolean

Whether more items exist (cursor pagination)

​
meta
object