Partner API Reference¶
Overview¶
The Partner API is a server-to-server REST API that lets approved partners manage their users, view transactions, and configure their widget integration. All endpoints require authentication via an API key issued by the Gyzer team.
Environments¶
| Environment | Base URL |
|---|---|
| Production | https://partners.gyzernetwork.com/ |
| Staging/Sandbox | https://partners-staging.gyzernetwork.com/ |
Use staging/sandbox for development and testing. Production keys and staging keys are separate—contact the Gyzer team for credentials per environment.
Online Documentation¶
For interactive API exploration and full request/response schemas:
- Production Swagger UI:
https://partners.gyzernetwork.com/docs/partners - Production OpenAPI Spec:
https://partners.gyzernetwork.com/openapi/partners.json - Staging/Sandbox Swagger UI:
https://partners-staging.gyzernetwork.com/docs/partners - Staging/Sandbox OpenAPI Spec:
https://partners-staging.gyzernetwork.com/openapi/partners.json
Authentication¶
All Partner API requests must include:
API keys are issued by Gyzer admins after partner approval. Store your key securely and never expose it in client-side code.
Base URL¶
All Partner API routes are under the /partners prefix. Example base URLs:
# Production
https://partners.gyzernetwork.com/partners
# Staging
https://partners-staging.gyzernetwork.com/partners
Endpoint Summary¶
| Group | Endpoint | Description |
|---|---|---|
| Profile | GET /partners/me |
Returns your partner identity (name, slug, status, contact info) |
| Users | POST /partners/users |
Create a new user attributed to your partner |
| Users | GET /partners/users |
List your users (with search, filters, pagination) |
| Users | GET /partners/users/{user_id} |
Get a specific user (if they belong to you) |
| Transactions | GET /partners/transactions |
List your transactions (deposits/withdrawals) |
| Transactions | GET /partners/transactions/{direction}/{id} |
Get transaction details |
| Reports | GET /partners/reports/payout |
Get your payout report (transaction counts, partner fees) |
| Settings | GET /partners/settings |
Get your settings (fees, branding, allowed origins) |
| Settings | PATCH /partners/settings |
Update branding (logo, CSS, allowed origins, metadata) |
| User Token | POST /partners/user-token |
Issue a short-lived token for the embed widget flow |
Full API Specification¶
For detailed request/response schemas, query parameters, and examples, see: