Create Payment Link

POST /api/link/generate

Generate a secure payment link for collecting crypto payments. Supports Solana, Bitcoin, and EVM chains (Base, Ethereum, Polygon, etc.).

API Reference

---

Authentication

All requests require authentication via the x-api-key header:

x-api-key: YOUR_API_KEY

---

Headers

Name	Value
Content-Type	application/json
x-api-key	your-api-key

---

Request Body Fields

Name	Type	Required	Description
tokenOut	object	Yes	Token configuration for receiving payment
receiver	string	Yes	Wallet address to receive payment
price	number	Yes	Amount to charge (must be ≥ 0)
name	string	No	Custom name/description for the payment
customOrderId	string	No	Your internal order reference
redirectUrl	string	No	Redirect URL after payment completes
type	string	No	single_use or unlimited

---

tokenOut Object

Field	Type	Required	Description
chainId	string	Yes	Chain ID: sol, btc, or EVM ID (e.g. 1, 137, 8453)
address	string	No*	Token contract address (required for EVM chains)

---

Chain Notes

• Solana: receiver must be a valid Solana address

• Bitcoin: receiver must be a valid BTC address

• EVM chains: receiver must be a valid 0x address, and tokenOut.address is required

---

Request Body Example

{
  "tokenOut": {
    "chainId": "8453",
    "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
  },
  "receiver": "0x8356D265646a397b2Dacf0e05A4973E7676597f4",
  "price": 100,
  "name": "Payment for Order #123",
  "customOrderId": "ORDER-123456",
  "redirectUrl": "https://merchant.example.com/thank-you",
  "type": "single_use"
}

---

Request Example (cURL)

curl -X POST "https://api.kira-pay.com/api/link/generate" \ 
-H "Content-Type: application/json" \ -H "x-api-key: YOUR_API_KEY" \ 
-d `{
  "tokenOut": {
    "chainId": "8453",
    "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
  },
  "receiver": "0x8356D265646a397b2Dacf0e05A4973E7676597f4",
  "price": 100,
  "name": "Payment for Order #123",
  "customOrderId": "ORDER-123456",
  "redirectUrl": "https://merchant.example.com/thank-you",
  "type": "single_use"
}`

---

Request Example (Node.js)

import axios from "axios";
async function createPaymentLink() {
    const response = await axios.post("https://api.kira-pay.com/link/generate", {
        tokenOut: {
            chainId: "8453",
            address: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
        },
        receiver: "0x8356D265646a397b2Dacf0e05A4973E7676597f4",
        price: 100,
        name: "Payment for Order #123",
        customOrderId: "ORDER-123456",
        redirectUrl: "https://merchant.example.com/thank-you",
        type: "single_use",
    }, {
        headers: {
            "x-api-key": process.env.KIRAPAY_API_KEY,
            "Content-Type": "application/json",
        },
    });
    console.log(response.data);
}
createPaymentLink();

---

Response Fields

Field	Type	Description
url	string	Generated payment link URL

---

Successful Response (201)

{ 
    "url": "https://checkout.kira-pay.com/abc123xyz7"
}

---

Error Responses

Status	Code	Description
400	INVALID_SOLANA_ADDRESS	Invalid Solana address format
400	INVALID_BITCOIN_ADDRESS	Invalid Bitcoin address format
400	INVALID_ADDRESS	Invalid EVM address format
400	INVALID_TOKEN_ADDRESS	Token address is required for EVM chain
400	INVALID_TOKEN	Token not supported
401	-	Invalid API key