Introduction - FlexyPe

The FlexyPe Checkout API lets you create checkout sessions, authenticate customers with phone-based OTP, and drive the checkout flow end to end. All endpoints accept and return JSON.

Base URL

All API requests are made to:

https://api.flexype.io

Authentication

Endpoints are authenticated with an API key sent as a bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

API key management

Access API Keys

In the dashboard, navigate to Settings → API Keys to manage your keys.

Manage API keys

Create, view, and revoke API keys for your store.

Generate a new key

Click Generate API Key, provide a name, and click Generate.

Store your key securely

The secret is shown only once. Copy it and store it somewhere secure — once you leave the page, the secret is no longer visible and you’ll need to generate a new key.

Authenticate your API requests

Send the key as a bearer token on every request:

curl https://api.flexype.io/session/{sessionId} \
  -H "Authorization: Bearer YOUR_API_KEY"

Never expose your secret API keys in client-side code or public repositories. Treat them like passwords.

Rate limits

The API allows 100 requests per minute. Requests without valid authentication headers are rate limited by IP address. When you exceed a limit, the API responds with HTTP 429 Too Many Requests. Back off and retry after a short delay.

Response format

Every response wraps its result in a consistent envelope.

{
  "status": "SUCCESS",
  "data": { }
}

{
  "status": "FAILURE",
  "error": {
    "code": "error.invalid-request",
    "message": "Human-readable error message"
  }
}

Create Checkout Session

​Base URL

​Authentication

​API key management

Manage API keys

​Rate limits

​Response format

Base URL

Authentication

API key management

Rate limits

Response format