API Reference

Create a new payment link

post

Generate a new payment link for receiving payments

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for authentication.

Body

application/json

receiverstringRequired

Wallet address to receive payment (Solana/Bitcoin/EVM)

Example: 0x8356D265646a397b2Dacf0e05A4973E7676597f4

pricenumberRequired

Payment amount

Example: 100

namestringOptional

Custom name/description for the payment link

Example: My Link

customOrderIdstringOptional

Your custom order identifier

Example: ORDER-123456

redirectUrlstring · uriOptional

URL to redirect after payment completion

typestring · enumOptionalExample: single_usePossible values:

Responses

201

Payment link created successfully

application/json

400

Invalid request parameters

application/json

401

Unauthorized - Invalid API key

application/json

post

/link/generate

HTTPcURLJavaScriptPython

POST /api/link/generate HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "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"
}

{
  "url": "https://pay.kirapay.io/abc123xyz7"
}