GET
/
projects
/
{projectId}
/
checkout
/
sessions
List checkout sessions
curl --request GET \
  --url https://api.simiz.io/v1/projects/{projectId}/checkout/sessions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cs_abc123",
      "url": "https://pay.simiz.io/cs/abc123",
      "amount": 5000,
      "currency": "XAF",
      "description": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "merchantName": "<string>",
      "merchantLogo": "<string>",
      "successUrl": "<string>",
      "cancelUrl": "<string>",
      "paymentId": "<string>",
      "customer": {
        "email": "<string>",
        "phone": "<string>"
      }
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

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

​
projectId
string<uuid>
required

UUID of the project

Query Parameters

​
page
integer
default:1
​
limit
integer
default:20
Required range: x <= 100
​
status
enum<string>

Checkout session lifecycle:

  • idle — Session created, waiting for payment initiation
  • processing — Payment being processed
  • pending_ussd — Waiting for USSD confirmation from payer
  • success — Payment completed
  • failed — Payment failed
  • expired — Session expired
  • cancelled — Session cancelled
Available options:
idle,
processing,
pending_ussd,
success,
failed,
expired,
cancelled

Response

Paginated list of checkout sessions

​
data
object[]
​
meta
object