Documentation

paytrack API documentation

Build customer, payment, agreement, reminder, report, and webhook integrations with a versioned API and server-safe keys.

Start in 5 minutes

1. Create a test API key with the scopes you need.
2. Call the customers or payments endpoint from your server.
3. Add a webhook endpoint and verify signed events.

Example

curl https://paytrack.ng/api/v1/customers \
  -H "Authorization: Bearer $PAYTRACK_API_KEY"

Start

Getting started

Create a test key, make your first request, and understand response envelopes.

Security

Authentication

Use bearer tokens safely from trusted servers.

Security

API keys

Scopes, environments, rotation, revocation, and operational hygiene.

Resources

Customers

Create, list, update, and search customer records.

Resources

Payment Plans

Manage agreements, instalments, balances, and collection plans. API v1 keeps the legacy tracks resource.

Resources

Payments

Record payments and reconcile customer balances.

Operations

Reminders

Send and audit follow-up messages.

Operations

Reports

Generate summaries and exports for teams.

Integrity

Ledger

Inspect cryptographic ledger events.

Events

Webhooks

Verify signatures and consume event deliveries.

Debugging

Errors

Status codes, request IDs, and error response formats.

Debugging

Rate limits

Plan limits, retry strategy, and quota handling.

SDKs

JavaScript SDK usage, typed examples, retries, and timeouts.

Start

Testing

Test keys, webhook tests, and mock-safe development.

Release

Changelog

API platform releases and compatibility notes.