> ## Documentation Index
> Fetch the complete documentation index at: https://docs.puplar.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Health check

> No authentication required.



## OpenAPI

````yaml /openapi.json get /health
openapi: 3.0.0
info:
  title: Puplar Integrations API
  version: 1.0.0
  description: >-
    Public API for integrators using **secret keys** (`sk_test_*` /
    `sk_live_*`). Authenticated routes need only **`Authorization: Bearer
    <secret_key>`**. Test keys sandbox payments, virtual accounts, KYC, and bank
    resolve — see guides/test-vs-live for fixtures. Responses follow `{ message,
    data?, errors? }`. Includes customers, collections, payments, products,
    invoices, payouts, wallets, virtual accounts, crypto, refunds, and webhooks.
  contact:
    name: Puplar Support
    email: support@puplar.com
servers:
  - url: https://api.puplar.com
    description: Production
security: []
tags:
  - name: Customers
    description: Customer CRUD and KYC documents
  - name: Virtual accounts
    description: Funding instructions and test deposit simulation
  - name: Webhooks
    description: >-
      Webhook endpoints and delivery logs. Subscriber verification: HMAC-SHA256
      of raw body with webhook secret, header `X-Signature: sha256=<hex>`.
  - name: Payments
    description: One-time payment collection via hosted checkout links
  - name: Crypto
    description: EVM crypto wallet addresses and supported tokens
  - name: Collections
    description: Reusable checkout links
  - name: Products
    description: Catalog items for invoices. Amounts are minor units.
  - name: Invoices
    description: Draft → finalize → paid or void. Finalize returns a payment URL.
  - name: Payouts
    description: >-
      Send wallet funds to a bank account or crypto wallet. Duplicate
      `reference` returns 409.
  - name: Wallets
    description: >-
      Wallet balances per currency (available, pending, total). Amounts in minor
      units.
  - name: Misc
    description: >-
      Country-scoped bank list and account name lookup for payouts (e.g. `ng`
      for Nigeria).
  - name: Meta
    description: Health and service info
paths:
  /health:
    get:
      tags:
        - Meta
      summary: Health check
      description: No authentication required.
      responses:
        '200':
          description: Service is up
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      uptime:
                        type: number
                      timestamp:
                        type: string

````