1. Raiz
FlamPix Gateway API
  • 📜 API Overview
  • ⚠️ API Base URL Migration Notice ⚠️
  • Docs
    • 🔑 Authentication & HMAC Signing
    • 🪝 Webhook
    • 🧵 Deposit Status Strings
    • 🚦 API Limits
  • Raiz
    • Create Deposit
      POST
    • Get Deposit Status
      GET
    • Get User Info
      GET
    • Health Check
      GET
    • Transaction Status Update
  • Schemas
    • Customer
    • DepositRequest
    • DepositResponse
    • UserInfoResponse
    • WebhookPayload
  1. Raiz

Health Check

GET
/ping
Verify API operational status.

Request

Authorization
or
Header Params

Responses

🟢200
application/json
API is operational.
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/ping' \
--header 'X-FlamPix-Key;' \
--header 'X-FlamPix-Key: {{FLAMPIX_API_KEY}}' \
--header 'X-FlamPix-Timestamp: {{X-FlamPix-Timestamp}}' \
--header 'X-FlamPix-Signature;' \
--header 'X-FlamPix-Signature: {{X-FlamPix-Signature}}'
Response Response Example
{
    "status": "ok",
    "timestamp": "2019-08-24T14:15:22.123Z"
}
Modified at 2025-12-23 02:00:56
Previous
Get User Info
Next
Transaction Status Update
Built with