API Overview

The Linka API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Environment URLs

HTTP Verbs

We use standard HTTP verbs to communicate intent:

• GET: Retrieve a resource or list of resources.
• POST: Create a new resource or execute a process.
• PUT: Update an existing resource.
• DELETE: Remove a resource.

Response Schema

All responses are wrapped in a standard top-level object to ensure consistency.

Successful Response

{
  "data": {
    "id": "res_123",
    "object": "wallet",
    "status": "active"
  },
  "request_id": "req_abc987"
}

Error Response

{
  "error": {
    "type": "invalid_request_error",
    "message": "The amount must be greater than 0.",
    "code": "parameter_invalid"
  },
  "request_id": "req_abc987"
}

Pagination

Lists of resources are paginated. We use limit and offset parameters to control results.

• Default limit: 20
• Max limit: 100

GET /v1/payments?limit=50&offset=100

Rate Limiting

To ensure platform stability, we apply rate limits to all API keys.

• Sandbox: 10 requests per second.
• Production: 100 requests per second (Adjustable based on plan).

If you exceed these limits, the API will return a 429 Too Many Requests status code.

SDKs

While you can use any HTTP client, we provide official SDKs to accelerate your integration:

• Linka Node.js SDK
• Linka Python SDK
• Linka Go SDK