Skip to main content

API Reference

API Reference

This reference lists stable REST endpoints, headers, and return schemas. Use it alongside the Authentication page and service-specific guides.

Base URL & Prefix​

EnvironmentURL
Productionhttps://api.keshflippay.com
API Prefix/api/v1

All paths below are relative to the API prefix.

Authentication Headers​

HeaderDescription
X-API-KeyYour public key
X-TimestampUNIX time in seconds
X-SignatureHMAC-SHA256 over `METHOD

See Authentication & Security for examples in JS/Python.

Crypto​

Addresses

  • POST /crypto/addresses/create — Create a deposit address
  • GET /crypto/addresses — List partner addresses

Withdrawals

  • POST /crypto/withdrawals/network-fee — Estimate network fee
  • POST /crypto/withdrawals — Create withdrawal

Transactions

  • POST /crypto/verify-transaction — Verify a transaction

Deposits (Legacy)

  • POST /crypto/deposits — Create deposit
  • GET /crypto/deposits/:id — Get deposit by ID

Balances

  • GET /crypto/balances/:partnerId — Get balances

Detailed request/response bodies: see Crypto APIs.

Fiat​

Deposits

  • POST /fiat/deposits — Create deposit
  • GET /fiat/deposits/:id — Get deposit
  • GET /fiat/deposits — List deposits

Withdrawals

  • POST /fiat/withdrawals — Create withdrawal
  • GET /fiat/withdrawals/:id — Get withdrawal
  • GET /fiat/withdrawals — List withdrawals

Balances

  • GET /fiat/balances/:partnerId — Get fiat balances

Metadata

  • GET /fiat/currencies — Supported currencies

Detailed request/response bodies: see Fiat APIs.

Webhooks​

  • Delivery: HTTPS POST to your configured endpoint
  • Headers: X-API-Key, X-Timestamp, X-Signature
  • Events: deposit., withdrawal., transaction.verified, balance.updated
  • Verification and retry policy: see Webhooks

Errors​

Notes on Stability​

  • Breaking changes will be communicated in advance and versioned under a new prefix (e.g., /api/v2).
  • New fields may be added to responses without notice; ignore fields you don’t consume.
  • Use idempotency keys on create operations to ensure safe retries.