Developer Docs

Integration Overview

Use this guide to move from authentication to live payments and merchant-managed subscriptions.

Base URL: https://api.tinkerpayments.com/v1

Recommended Order

  1. Authenticate your app and obtain a bearer token.
  2. Implement idempotency for all write operations.
  3. Initiate payment when collecting one-time charges.
  4. Query payment status for reconciliation and UX updates.
  5. Implement normalized error handling and retry policy.
  6. Configure webhook verification plus delivery retry handling.
  7. Add refund/void flows before production launch.
  8. Complete go-live and security checklist with your compliance team.

SDKs & Plugins

Official SDK links and platform integrations

Authentication

Get app tokens for all requests

Payment Initiate

Create payment sessions

Payment Query

Check payment status by reference

Subscriptions

Plans and subscriptions for merchant customers

Webhooks

Event payloads and verification

Idempotency

Safe retries and duplicate prevention

Error Model

Normalized error codes and handling

Refunds

Refund, void, and partial refund behavior

Methods & Wallets

Payment methods, wallets, and mandates

Rate Limits

Throttling, headers, and pagination

Webhook Delivery

Retries, guarantees, and callback service

Go-Live Checklist

Production readiness checklist

Security

Keys, scopes, and hardening guidance

Platform Plugins

WooCommerceAvailable
ShopifyPlanned
WordPressPlanned
MagentoPlanned

Need another plugin? Contact support.