API Documentation

PulsePay Developer API

Integrate PulsePay's biometric payment system into your applications and websites. Our API provides secure, fast, and reliable payment processing capabilities.

API Status: Coming Soon

Our public API is currently in development. Register for early access and updates.

Getting Started

Authentication

All API requests require authentication using API keys. You'll need:

Public Key: For client-side operations
Secret Key: For server-side operations (keep secure)
Webhook Secret: For verifying webhook authenticity

Base URL

                    https://api.pulsepay.com/v1/
                

Core Endpoints

Payment Processing

Create Payment Intent

POST /payments/create

Create a new payment intent for biometric authentication.

Request Body:

{
  "amount": 1000,
  "currency": "INR",
  "description": "Product purchase",
  "customer_id": "cust_123",
  "merchant_id": "merch_456",
  "metadata": {
    "order_id": "order_789"
  }
}

Verify Payment

POST /payments/verify

Verify biometric authentication and process payment.

Get Payment Status

GET /payments/{payment_id}

Retrieve the current status of a payment.

Customer Management

Create Customer

POST /customers

Get Customer

GET /customers/{customer_id}

Update Customer

PUT /customers/{customer_id}

Biometric Management

Register Biometric

POST /biometrics/register

Verify Biometric

POST /biometrics/verify

Webhooks

PulsePay sends webhooks to notify your application about payment events:

payment.created - Payment intent created
payment.processing - Payment being processed
payment.succeeded - Payment completed successfully
payment.failed - Payment failed
payment.cancelled - Payment cancelled

SDKs and Libraries

JavaScript SDK

For web applications

Android SDK

For mobile apps

Python Library

For server-side integration

Node.js Library

For Node.js applications

Testing

Sandbox Environment

Test your integration using our sandbox environment:

                        https://sandbox-api.pulsepay.com/v1/
                    

No real money transactions
Test biometric data available
Simulate various payment scenarios

Security Considerations

Always use HTTPS for API calls
Store API keys securely (environment variables)
Validate webhook signatures
Implement proper error handling
Use rate limiting in your applications
Never expose secret keys in client-side code

Rate Limits

Payment API: 100 requests per minute
Customer API: 60 requests per minute
Biometric API: 30 requests per minute

Support

For API-related questions and technical support:

Developer Support: dev-support@pulsepay.com
Documentation Issues: docs@pulsepay.com
Community Forum: developers.pulsepay.com

Want Early Access?

Email: pulsexpay999@gmail.com