API Reference Overview
The Wajub REST API — base URL, authentication, conventions and resource list.
The Wajub API is organized around REST: predictable URLs, JSON bodies, standard HTTP codes and key-based authentication. A single base URL serves both environments.
Built-in Playground
Configure your API keys in the top bar, then use the Test this endpoint button on each resource page to send real requests from the documentation.
Base URL
https://api.wajub.comAll requests must use HTTPS. HTTP requests are redirected.
Quick authentication
Authorization: sk_test.2a7c5e91b0d34f68Authorization— your API key. Use a private key (sk.…/sk_test.…) for server-side operations (transfers, refunds, balance reads), a public key (pk.…/pk_test.…) for client-side operations, or a restricted key (rk.…/rk_test.…) scoped to specific resources.
See Authentication for full details.
Response structure
All API responses share a consistent JSON envelope:
{
"status": "OK",
"message": "The transaction has been fetched",
"code": 200,
"transaction": { /* resource data */ }
}{
"status": "Unprocessable Content",
"message": "Some fields are invalid",
"code": 422,
"errors": {
"amount": ["The amount must be at least 100."]
}
}See Response structure for the full format.
Conventions
| Topic | Description |
|---|---|
| Authentication | Public, private, and restricted keys |
| Errors | HTTP codes and errors field structure |
| Failure Reasons | Complete catalog of reason codes |
| Pagination | per_page / page / cursor parameters |
| Rate limits | Quotas and X-RateLimit-* headers |
| Idempotency | Replay requests without double-charging |
| Versioning | Date-based API versions |
Resources
| Resource | Key endpoints |
|---|---|
| Payments | POST /payments, GET /payments/{id} |
| Refunds | POST /refunds |
| Transfers | POST /transfers, GET /transfers/{id} |
| Customers | POST /customers, GET /customers/{id} |
| Subaccounts | POST /accounts |
| Balance | GET /balance |
| Events | GET /events |
| Beneficiaries | POST /beneficiaries |
| Webhook Endpoints | POST /webhook-endpoints |
| Payment Links | POST /links |
| Invoices | POST /invoices |
| Disputes | GET /disputes |