​
REST API

The Simiz REST API is the foundation that all SDKs are built on. Use it directly with cURL, Postman, or any HTTP client.

​
Base URL

https://api.simiz.io/v1/
The same base URL is used for both sandbox and production — the API key determines the environment.

​
Authentication

All requests require a Bearer token in the Authorization header: 
curl https://api.simiz.io/v1/transactions \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxx"

​
Request format

  • Content-Type: application/json
  • Accept: application/json
  • Method: POST for creates, GET for reads, PATCH for updates, DELETE for deletes

​
Response format

All responses follow this structure: 
{
  "id": "tx_abc123",
  "object": "transaction",
  "amount": 5000,
  "currency": "XAF",
  "status": "PENDING",
  "created_at": "2024-03-15T10:30:00Z"
}
List endpoints return paginated results: 
{
  "data": [
    { "id": "tx_abc123", ... },
    { "id": "tx_def456", ... }
  ],
  "has_more": true,
  "total_count": 150
}

​
Pagination

ParameterTypeDefaultDescription
limitinteger20Items per page (1–100)
starting_afterstring—Cursor for forward pagination
ending_beforestring—Cursor for backward pagination

​
API versioning

Include the version in the URL path or as a header: 
# URL versioning (recommended)
https://api.simiz.io/v1/transactions

# Header versioning
curl https://api.simiz.io/transactions \
  -H "Simiz-Version: 2024-01"

​
Available endpoints

MethodEndpointDescription
Transactions
POST/v1/transactionsCreate a transaction
GET/v1/transactions/:idRetrieve a transaction
GET/v1/transactionsList transactions
POST/v1/transactions/:id/cancelCancel a transaction
Refunds
POST/v1/refundsCreate a refund
GET/v1/refunds/:idRetrieve a refund
GET/v1/refundsList refunds
Subscriptions
POST/v1/subscriptionsCreate a subscription
GET/v1/subscriptions/:idRetrieve a subscription
PATCH/v1/subscriptions/:idUpdate a subscription
POST/v1/subscriptions/:id/cancelCancel a subscription
Payouts
POST/v1/payoutsCreate a payout
GET/v1/payouts/:idRetrieve a payout
GET/v1/payoutsList payouts

​
Changelog

Version history

VersionDateChanges
1.0.02026-02-27Initial API release — payments, webhook events, billing