API reference - Flipeet Pay API

Base URL

https://api.pay.flipeet.io

All endpoints are under /api/v1. The same URL serves the sandbox and live: your key decides which.

Authentication

Send your secret key in the x-api-key header. See Authentication.

curl https://api.pay.flipeet.io/api/v1/merchant/balance \
  -H "x-api-key: $FLIPEET_SECRET_KEY"

Requests and responses

Send JSON with Content-Type: application/json. Amounts are JSON numbers in the unit of their currency or token (25000 is ₦25,000, 100.5 is 100.5 USDC), never strings. Every response has the same envelope, with the result in data:

{
  "message": "Balance retrieved",
  "status": "success",
  "statusCode": 200,
  "data": { "livemode": true, "balances": [{ "currency": "usdc", "available": 1240.5 }] }
}

Errors have status: "error", a stable code and a requestId. See Errors.

Try it

Every endpoint page has a playground. Paste a sandbox key (fpay_test_…) to send real requests to the sandbox. Use only a sandbox key there, never a live one.