GET
/
payments
/
user
/
{userId}
List payments by user
curl --request GET \
  --url https://api.simiz.io/v1/payments/user/{userId} \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "token": "pay_abc123xyz789",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "<string>",
    "amount": 5000,
    "currency": "XAF",
    "paymentUrl": "<string>",
    "payerPhone": "<string>",
    "payerName": "<string>",
    "payerEmail": "<string>",
    "description": "<string>",
    "livemode": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  }
]

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.

Path Parameters

​
userId
string<uuid>
required

UUID of the user

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

List of payments for this user

​
id
string<uuid>
​
token
string

Unique payment token

Example:

"pay_abc123xyz789"

​
projectId
string<uuid>
​
reference
string | null
​
amount
number
Example:

5000

​
currency
string
Example:

"XAF"

​
status
enum<string>

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>

Payment methods supported:

  • ORANGE_MONEY — Orange Money
  • MTN_MOMO — MTN Mobile Money
  • UNKNOWN — Fallback / not yet determined
Available options:
ORANGE_MONEY,
MTN_MOMO,
UNKNOWN
​
paymentUrl
string<uri> | null

URL to redirect the customer for payment

​
payerPhone
string | null
​
payerName
string | null
​
payerEmail
string | null
​
description
string | null
​
livemode
boolean

Whether this is a production transaction

​
createdAt
string<date-time>
​
completedAt
string<date-time> | null