API v1.0 Reference

Welcome to the iNPAY Checkout API v1.0 reference. This page provides the foundation you need for server‑side calls that complement the Checkout modal.

As of now, the primary integration path is the inline Checkout modal. Additional server endpoints will be rolled out and documented here as they become available.

Base URLs

Use the environment that matches your keys:

Sandbox:    https://api-sandbox.inpaycheckout.com/v1
Production: https://api.inpaycheckout.com/v1

Authentication

Server‑side API requests use your Secret key. Include it in the Authorization header:

Authorization: Bearer sk_live_xxx   # or sk_test_xxx for sandbox

Never use your Secret key in client code. The Checkout modal uses your Public key (pk_...) and does not require server credentials.

Response Shape

JSON responses follow this general shape:

{
  "success": true,
  "data": {},
  "error": null,
  "timestamp": "2025-01-01T00:00:00Z"
}

On errors:

{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request is invalid"
  },
  "timestamp": "2025-01-01T00:00:00Z"
}

Common Error Codes

Code	Description
INVALID_REQUEST	The request parameters are invalid
UNAUTHORIZED	Invalid or missing API key
FORBIDDEN	Insufficient permissions
NOT_FOUND	Resource not found
RATE_LIMITED	Rate limit exceeded
SERVER_ERROR	Internal server error

Endpoints (Initial)

Initial public endpoints will be published here. For now, implement the Checkout modal and verify transactions server‑side using webhooks. Direct verification endpoints will be documented as they become available.

Webhooks

See the guide: /docs/guides/webhooks

SDKs

Official SDKs and sample clients are coming soon.