​
Payments — REST API

​
Create a transaction

curl -X POST https://api.simiz.io/v1/transactions \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -d '{
    "amount": 5000,
    "currency": "XAF",
    "payment_method": "ORANGE_MONEY",
    "payer": {
      "phone": "237690000000",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "description": "Order #12345",
    "reference": "ORDER-123",
    "metadata": {
      "order_id": "123"
    },
    "callback_url": "https://your-site.com/webhooks/simiz",
    "return_url": "https://your-site.com/success"
  }'
Response (201 Created): 
{
  "id": "tx_abc123",
  "object": "transaction",
  "amount": 5000,
  "currency": "XAF",
  "status": "PENDING",
  "payment_method": "ORANGE_MONEY",
  "payment_url": "https://checkout.simiz.io/cs_xxxxxxxxxxxx",
  "payer": {
    "phone": "237690000000",
    "name": "John Doe"
  },
  "description": "Order #12345",
  "reference": "ORDER-123",
  "created_at": "2024-03-15T10:30:00Z"
}

​
Retrieve a transaction

curl https://api.simiz.io/v1/transactions/tx_abc123 \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxx"

​
List transactions

curl "https://api.simiz.io/v1/transactions?limit=20&status=COMPLETED" \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxx"

​
Query parameters

ParameterTypeDescription
limitintegerItems per page (1–100)
statusstringFilter by status
payment_methodstringFilter by payment method
created_afterstringISO date filter
created_beforestringISO date filter
starting_afterstringPagination cursor

​
Cancel a transaction

curl -X POST https://api.simiz.io/v1/transactions/tx_abc123/cancel \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxx"

​
Create a refund

curl -X POST https://api.simiz.io/v1/refunds \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "transaction_id": "tx_abc123",
    "amount": 2500,
    "reason": "Item returned"
  }'
Response: 
{
  "id": "rf_xyz789",
  "object": "refund",
  "transaction_id": "tx_abc123",
  "amount": 2500,
  "currency": "XAF",
  "status": "PENDING",
  "reason": "Item returned",
  "created_at": "2024-03-16T08:00:00Z"
}