DEVELOPER CENTER

API documentation

Versioned REST API foundation. Provider-backed payment creation is disabled until configured.

API v1

Authentication

Authenticated endpoints expect X-API-Key and X-API-Secret. Secrets must be stored securely on your server and never exposed in browser JavaScript.

 X-API-Key: your_key_prefix...
 X-API-Secret: your_secret

Health check

GET /api/v1/health

{"ok":true,"product":"YOUPI Payment Gateway","release":"1.0.2","api_version":"v1"}

Create payment

POST /api/v1/payments

{
  "amount_minor": 12900,
  "currency": "INR",
  "order_reference": "ORDER-10001"
}

Returns HTTP 503 until an authorized provider adapter is configured. It will never return a fabricated success.

Payment status

GET /api/v1/payments/{payment_id}

Returns status only for the authenticated merchant's own payment.

Transactions

GET /api/v1/transactions?limit=25&offset=0

Paginated records for the authenticated merchant.

Production requirements

Provider signature verification, idempotency, callback replay protection, webhook signing/retries, live/sandbox separation and reconciliation must be implemented against your provider's official docs.