API Documentation

Getting Started

Welcome to the Siapay API documentation. Our APIs are designed to be simple, secure, and developer-friendly. Follow this guide to quickly integrate Siapay into your application.

Quick Start Guide

Base URL

Production: https://api.siapay.io/v1
Test Mode: https://test-api.siapay.io/v1

Authentication

Siapay uses API keys to authenticate requests. You can find your API keys in your Siapay Dashboard. Authentication is performed via HTTP Bearer authentication.

Using Your API Key

Include your API key in the Authorization header of every request:

curl https://api.siapay.io/v1/payments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Key Types

API Reference

Complete reference for all Siapay API endpoints. All requests should be made over HTTPS with valid authentication.

const payment = await fetch('https://api.siapay.io/v1/payments', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 50000, // ₹500.00
    currency: 'INR',
    customer: {
      email: 'customer@example.com',
      phone: '+919999999999',
      name: 'John Doe'
    },
    description: 'Order #12345',
    metadata: {
      order_id: '12345'
    }
  })
});

{
  "id": "pay_1234567890",
  "object": "payment",
  "amount": 50000,
  "currency": "INR",
  "status": "created",
  "customer": {
    "email": "customer@example.com",
    "phone": "+919999999999",
    "name": "John Doe"
  },
  "description": "Order #12345",
  "metadata": {
    "order_id": "12345"
  },
  "payment_link": "https://pay.siapay.io/p/pay_1234567890",
  "created_at": 1643723400,
  "expires_at": 1643809800
}

{
  "error": {
    "code": "invalid_request",
    "message": "The amount parameter is required",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

Webhooks

Webhooks allow you to receive real-time notifications about events in your Siapay account. When an event occurs, we'll send an HTTP POST request to your webhook endpoint.

Setting Up Webhooks

1. Go to your Siapay Dashboard
2. Navigate to Developers → Webhooks
3. Add your webhook endpoint URL
4. Select the events you want to receive

Webhook Security

All webhook requests include a signature in the X-Siapay-Signature header. Verify this signature to ensure the webhook is from Siapay.

const crypto = require('crypto');

function verifyWebhookSignature(payload, signature, secret) {
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
  
  return signature === expectedSignature;
}

Error Handling

Siapay uses conventional HTTP response codes to indicate the success or failure of API requests. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with Siapay's servers.

HTTP Status Codes

Error Response Format

{
  "error": {
    "code": "resource_not_found",
    "message": "No such payment: pay_1234567890",
    "param": "id",
    "type": "invalid_request_error"
  }
}

SDKs & Libraries

We provide official SDKs for popular programming languages to make integration easier. All SDKs are open source and available on GitHub.

npm install @siapay/node

pip install siapay

composer require siapay/siapay-php

gem install siapay

<dependency>
  <groupId>io.siapay</groupId>
  <artifactId>siapay-java</artifactId>
  <version>1.0.0</version>
</dependency>

go get github.com/siapay/siapay-go