For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Resources

API Resources

The API Resources section contains common platform configuration details and shared integration resources used across KwikPaisa APIs.

Use this page as a quick reference for:

  • Base URLs

  • API environments

  • Request formats

  • Response formats

  • Supported currencies

  • Transfer modes

  • API versioning

  • Developer utilities


API Environments

KwikPaisa provides separate environments for testing and production usage.

Environment
Purpose

Sandbox

Development and testing

Production

Live transaction processing


Base URLs

Sandbox

Used for:

  • Integration testing

  • UAT validation

  • Mock transaction flows

  • Webhook testing


Production

Used for:

  • Live customer payments

  • Real payout processing

  • Production banking operations


API Versioning

Current API version:

Example endpoint structure:


Request Format

All API requests should use:

Request bodies must:

  • Use valid JSON

  • Follow endpoint-specific schemas

  • Include required parameters


Response Format

All API responses are returned in JSON format.

Example response structure:


Character Encoding

Supported encoding:


Timezone Standard

Recommended timezone handling:

Timestamps should use:

  • UNIX timestamps (seconds)

  • Server-side generation


Supported Currencies

KwikPaisa supports multi-currency processing for global payment and banking workflows.

Supported currencies may vary depending on:

  • Merchant category

  • Settlement region

  • Banking partner support

  • Regulatory requirements

  • Cross-border enablement


Currency
Code

Indian Rupee

INR

US Dollar

USD

Euro

EUR

British Pound Sterling

GBP

United Arab Emirates Dirham

AED

Singapore Dollar

SGD

Canadian Dollar

CAD

Australian Dollar

AUD

Japanese Yen

JPY

Chinese Yuan Renminbi

CNY

Hong Kong Dollar

HKD

Swiss Franc

CHF

Saudi Riyal

SAR

Qatari Riyal

QAR

Kuwaiti Dinar

KWD

Bahraini Dinar

BHD

Omani Rial

OMR

Malaysian Ringgit

MYR

Thai Baht

THB

Indonesian Rupiah

IDR

Philippine Peso

PHP

South African Rand

ZAR

New Zealand Dollar

NZD

Turkish Lira

TRY

Brazilian Real

BRL

Mexican Peso

MXN

South Korean Won

KRW

Danish Krone

DKK

Swedish Krona

SEK

Norwegian Krone

NOK

Polish Zloty

PLN

Czech Koruna

CZK

Hungarian Forint

HUF

Israeli New Shekel

ILS


Important Notes

  • Currency availability may vary by merchant account

  • Cross-border payouts may require additional approval

  • Certain currencies may support payments only

  • Settlement currencies may differ from transaction currencies

  • FX conversion rates may apply for international transactions


Supported Transfer Modes

Transfer Mode
Description

imps

Instant bank transfer

neft

Standard bank settlement

rtgs

Real-time gross settlement

upi

UPI-based transfer

ach

Automated clearing transfer

wire

International wire transfer

swift

SWIFT international transfer

sepa

European SEPA transfer


Authentication Method

KwikPaisa APIs use:

  • API Key authentication

  • HMAC SHA256 request signing

  • UNIX timestamp validation

Authentication references:


HTTP Methods

Supported API methods:

Method
Usage

POST

Create or process requests

GET

Retrieve resource data


Common HTTP Status Codes

KwikPaisa APIs use standard HTTP status codes along with structured API responses to indicate request status, authentication results, validation errors, transaction states, and server-side processing outcomes.

Merchants should always validate:

  • HTTP status codes

  • API response body

  • Transaction status values

  • Error messages


HTTP Code
Status
Description

200

Success

Request processed successfully

201

Created

Resource or transaction created successfully

400

Bad Request

Invalid request payload or malformed request

401

Unauthorized

Authentication failed or invalid signature

403

Forbidden

Access denied or invalid environment access

404

Not Found

Requested resource or transaction not found

409

Conflict

Duplicate request or duplicate transaction reference

422

Unprocessable Entity

Business validation failed

429

Too Many Requests

API rate limit exceeded

500

Internal Server Error

Unexpected server-side processing error

502

Bad Gateway

Banking or upstream network failure

503

Service Unavailable

Temporary downtime or maintenance


Example Success Response


API Rate Limits

API rate limits may apply depending on:

  • Merchant category

  • Environment

  • Transaction volume

  • Risk profile

Recommended reference:

➡️ Rate Limits


Postman Collection

KwikPaisa Postman collections help developers:

  • Test APIs quickly

  • Validate authentication

  • Simulate transaction flows

Recommended usage:

  • Sandbox testing

  • UAT validation

  • Webhook testing


SDK Support

Official SDKs may be available for:

  • PHP

  • Node.js

  • Python

  • Java

  • .NET

  • Go

SDK availability may vary by API category.


Webhook Resources

Webhook integration references:


Production Resources

Production readiness references:

➡️ Going Live ➡️ Production Checklist ➡️ Security Checks ➡️ IP Whitelisting


Support

For:

  • API onboarding

  • Production activation

  • Payout enablement

  • Sandbox access

  • Integration support

contact the KwikPaisa onboarding and integration team.

Last updated