API Reference
API Reference
A small, predictable JSON API over HTTPS.
Base URL#
Base URL
https://api.kardlane.comAuthentication#
Every request except GET /v1/card-types needs Authorization: Bearer <project API key>. See Authentication.
Endpoints#
Create a trade
POST /v1/trades
Retrieve a trade
GET /v1/trades/{id}
Resolve a trade
POST /v1/trades/{id}/resolve
Pause the bot on a trade
POST /v1/trades/{id}/pause
Resume the bot on a trade
POST /v1/trades/{id}/resume
Stop the bot on a trade
POST /v1/trades/{id}/stop
List card types
GET /v1/card-types
Webhook events#
trade.succeeded
The vendor redeemed the card and paid, and Kardlane verified it (or you resolved it as succeeded).
trade.failed
The vendor rejected the card.
trade.escalated
A person needs to decide — the agent wasn’t sure, a check held it back (e.g.
trade.cancelled
Someone closed the trade as handled outside Kardlane.
connection.disconnected
One of your WhatsApp numbers lost its session — vendors in its groups can’t be reached until it’s re-linked in the dashboard..
billing.balance_low / suspended / restored
Your prepaid Kardlane balance crossed a threshold.