Skip to main content

TagadaPay API

The TagadaPay API is a REST API that lets you process payments, manage subscriptions, handle customers, deploy plugins, and orchestrate checkout funnels — all programmatically.

Base URL

A sandbox environment is available for testing:

Authentication

Authenticate every request with a Bearer token in the Authorization header. Get your API key from the TagadaPay Dashboard.
Keep your API keys secure. Never expose them in client-side code, public repositories, or logs.

Authentication troubleshooting

A missing, empty, or malformed Authorization header returns 401 with a message explaining what was wrong:
Common causes:
  • Empty shell variableAuthorization: Bearer $KEY with $KEY unset sends an empty token. Verify with echo ${#KEY} before calling.
  • Wrong header — the key must be in Authorization: Bearer <key>, not in a custom header.
  • Wrong key type — public API endpoints accept dashboard API keys (Settings → API Keys) and TPA-restricted tp_sk_… partner keys.
Older API versions surfaced this situation as a confusing 500 mentioning Clerk: auth() was called but Clerk can't detect usage of clerkMiddleware(). If you see that error, it means the same thing: your API key did not reach the server — fix the Authorization header.

Request format

  • All requests must use HTTPS
  • Set Content-Type: application/json for POST/PUT requests
  • All responses return JSON

Rate limits

Exceeding the limit returns 429 Too Many Requests with a Retry-After header.

Error codes

Error responses follow this structure:

Pagination

List endpoints support pagination via request body parameters:
Used by payments, orders, customers, and block rules.

Filtering

Most list endpoints accept a filters object. Common patterns:
Date filter conditions: is-equal-date, is-between-date, is-after-date, is-before-date.

Webhooks

Register webhook endpoints to receive real-time event notifications for payments, orders, subscriptions, and more. See the Webhooks API section.

SDKs

Node.js SDK

Server-side SDK for Node.js / TypeScript

Plugin SDK

Build custom checkout plugins with React

Plugin CLI

Deploy and manage plugins from the command line

Need help?