Skip to main content
GET
/
v1
/
checkouts
Checkout sessions
curl --request GET \
  --url https://api.example.com/v1/checkouts \
  --header 'Authorization: Bearer <token>'
{
  "sessions": [
    {
      "id": "cs_ci_123456789",
      "status": "created",
      "amount": 5000,
      "currency": "XOF",
      "user_phone": "+22507987654",
      "payment_id": "ORDER_123",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "failure_reason": "<string>",
      "transaction_fee": 25
    }
  ],
  "total_count": 123,
  "has_more": true,
  "next_offset": 123
}

​
Checkout Sessions API

This API allows you to create and manage checkout sessions for processing payments. You can create new sessions, retrieve existing ones, and handle various payment methods and integrations.

​
Endpoints

​
Create Checkout Session

  • Endpoint: POST /v1/checkouts
  • Description: Create a new checkout session.
  • Request Body: 
    {
  "amount": 1000,
  "currency": "usd",
  "payment_method_types": ["card"]
}
  • Response: 
    {
  "id": "cs_test_123",
  "amount": 1000,
  "currency": "usd",
  "status": "created"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
status
enum<string>

Retrieve all checkout operations (failed, sucess)

Available options:
created,
pending,
processing,
completed,
failed,
expired,
cancelled
​
limit
integer
default:50
​
offset
integer
default:0

Response

200 - application/json

Sessions

​
sessions
object[]
​
total_count
integer
​
has_more
boolean
​
next_offset
integer