Quickstart

Quickstart with keshflippay

This guide helps you set up your development environment, authenticate API requests, and make your first successful transaction using the keshflippay Partner API.

---

Overview

The keshflippay API allows you to process payments, manage balances, and interact with crypto and fiat networks securely.
All communication with the API is performed over HTTPS, and requests must be authenticated using your API keys and HMAC signatures.

Before you start, ensure you have access to the developer dashboard where you can generate and manage your API keys.

---

1. Prerequisites

To begin integration, you will need:

• A keshflippay developer account
• A valid API key pair (public and secret)
• Access to the sandbox environment
• Basic knowledge of HTTP requests and JSON
• Node.js or Python installed locally

You can sign up and obtain credentials via the developer portal (coming soon).

---

2. Base URLs

All requests are made to the following API endpoints:

Environment	Base URL
Production	https://api.keshflippay.com/v1
Sandbox	https://sandbox.keshflippay.com/v1

Use the sandbox environment for initial testing and development.

---

3. Authentication

Each request must be signed using your secret key.
The signature ensures request integrity and prevents unauthorized access.

Header	Description
X-keshflippay-Key	Your public API key.
X-keshflippay-Timestamp	Current Unix timestamp.
X-keshflippay-Signature	HMAC-SHA256 signature of the message.

Refer to Authentication & Security for detailed implementation and verification examples.

---

4. Installation

You can use the official SDKs for faster integration.

JavaScript / TypeScript

Terminal

npm install keshflippay

Or, using Yarn:

Terminal

yarn add keshflippay

Python

Terminal

pip install keshflippay

---

5. Making Your First API Request

Here is an example of initiating a balance inquiry using both SDKs.

JavaScript / TypeScript

example.js

import keshflippay from "keshflippay";

const client = new keshflippay({
apiKey: process.env.keshflippay_KEY,
secret: process.env.keshflippay_SECRET,
baseUrl: "https://sandbox.keshflippay.com/v1",
});

async function main() {
const balance = await client.accounts.getBalance();
console.log("Current Balance:", balance);
}

main();

Python

example.py

from keshflippay import keshflippay
import os

client = keshflippay(
  api_key=os.getenv("keshflippay_KEY"),
  secret=os.getenv("keshflippay_SECRET"),
  base_url="https://sandbox.keshflippay.com/v1",
)

balance = client.accounts.get_balance()
print("Current Balance:", balance)

---

6. Handling Responses

All responses from the API are JSON objects containing:

Field	Description
status	Status of the request (success, error).
data	The main response payload.
message	Human-readable message for additional context.

Response Example

{
"status": "success",
"data": {
  "balance": {
    "currency": "USD",
    "available": 2500.50
  }
},
"message": "Balance retrieved successfully."
}

---

7. Common Errors

Refer to the Error Codes documentation for details on standard error formats and meanings.

---

8. Next Steps

• Learn about Authentication and secure request signing.
• Explore Crypto APIs and Fiat APIs.
• Configure Webhooks for real-time event notifications.
• Use the API Reference to view all available endpoints.