API Reference
Payments API
The Payments API lets you initiate, track, and manage payments across all connected bank accounts from a single normalised endpoint. Payments are idempotent — safe to retry on network failures using the Idempotency-Key header.
Base URL
# Base URL for all API v1 requests
https://api.lynqx.io/v1
Endpoints
All endpoints require a Bearer token in the Authorization header. Responses are JSON. Successful responses return 200 for reads and 201 for creates.
POST/paymentsInitiate a payment
GET/payments/{id}Get payment by ID
GET/paymentsList all payments
DELETE/payments/{id}/cancelCancel a pending payment
Request example
# POST /payments
curl -X POST https://api.lynqx.io/v1/payments
-H "Authorization: Bearer lnqx_sk_prod_xxxxxxxxxxxx"
-H "Content-Type: application/json"
-d '
{
"from": "erp:sap-prod",
"to": "bank:hdfc-current",
"amount": 240000,
"currency": "INR",
"reference": "INV-20482"
}'
Webhook payload
Lynqx delivers a signed JSON payload to your registered endpoint for every significant state change. Verify the X-Lynqx-Signature header using HMAC-SHA256.
// Webhook payload example
{
"id": "evt_01HX...",
"type": "payment.sent",
"createdAt": "2025-04-29T10:34:12Z",
"data": {
"txnId": "lnqx_txn_8f3a...",
"amount": 240000,
"currency": "INR",
"status": "sent"
}
}
Errors
Lynqx uses standard HTTP status codes. All errors return a JSON body with a code and message field.
Need help?
Our team is available 24/7 for enterprise customers.