Client API: Partners
Every Client API operation tagged Partners.
Base URL: https://api.coritan.com/api/v1. Paths below are complete.
To try these requests in the browser, open the interactive Client API reference.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/partners/terms |
The reseller program's terms as they stand today |
The reseller program's terms as they stand today
Section titled The reseller program's terms as they stand todayGET /api/v1/partners/terms
The reseller program's terms as they stand today. No sign in needed.
These are the terms a new organization starts with. Our staff can agree
other figures with one organization, and the dashboard shows that
organization its own. A figure the platform does not set is null. The
answer is the same for everyone who asks, and a shared cache may keep it
for up to a minute.
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
Fields of a 200 response:
| Field | Type | Description |
|---|---|---|
platform_fee_percent |
number or null | The platform fee a new organization starts with: this percentage of what our payment gateways collect for it, after refunds and chargebacks. |
payout_schedule |
string or null | How often we pay out what our gateways collected: monthly, or null when payouts have no regular schedule. |
payout_minimum |
number or null | The smallest payout we make, or null when we pay any amount above zero. |
currency |
string | The currency we pay out in. |
limits |
PartnerLimits | What a new organization may have. Our staff can raise a limit for one organization. |
limits.customers |
integer or null | How many customers a new organization may have. |
limits.services |
integer or null | How many services its customers may have between them. |
limits.products |
integer or null | How many products of its own it may sell. |