Documentation
paytrack API documentation
Build payment tracking integrations with the REST API, SDKs, CLI and webhooks. Find resource references, local setup instructions and clear availability notes.
Your first request
- 1. Create a test API key with the scopes you need.
- 2. Make a read-only account or customer request from your server.
- 3. Add a webhook endpoint and verify signed events.
curl https://paytrack.ng/api/v1/customers \ -H "Authorization: Bearer $PAYTRACK_API_KEY"
16 guides to explore.
Getting started
Create a test key, make your first request, and understand response envelopes.
SecurityAuthentication
Use bearer tokens safely from trusted servers.
SecurityAPI keys
Scopes, environments, rotation, revocation, and operational hygiene.
ResourcesCustomers
Create, list, update, and search customer records.
ResourcesPayment Plans
Manage agreements, instalments, balances, and collection plans. API v1 keeps the legacy tracks resource.
ResourcesPayments
Record payments and reconcile customer balances.
OperationsReminders
Understand reminder resources and current delivery availability.
OperationsReports
Generate summaries and exports for teams.
IntegrityLedger
Inspect cryptographic ledger events.
EventsWebhooks
Verify signatures and consume event deliveries.
DebuggingErrors
Status codes, request IDs, and error response formats.
DebuggingRate limits
Plan limits, retry strategy, and quota handling.
SDKsCLI
Build the local CLI, inspect records and use JSON output in scripts.
SDKsSDKs
JavaScript/TypeScript, Python, local setup and SDK response shapes.
StartTesting
Test keys, webhook tests, and mock-safe development.
ReleaseChangelog
API platform releases and compatibility notes.