Manage keys
Open API Keys and select Create Key. Choose a server key for your backend or a client key for your application. Keep server keys on your backend and store them when you create them: the full value is shown only once. For client keys, set the mode, allowed origins, and scopes to match the access your application needs. You can disable or revoke a key from the same page.Register an affiliate
Open Affiliates and select New affiliate. Give it an ID for API attribution, set a fee rate, and choose a payout destination and address. An optional alias makes the affiliate easier to recognize in your dashboard. Fee rates are in basis points, from 1 to 9999. For example, 100 bps is 1% of the amount after the platform fee. Pass the ID inaffiliateIds on quote requests to attribute fees. See Fees for API registration and request overrides.
To update an affiliate, open its Settings. Changing the payout destination affects fees recorded after the change; existing balances keep their recorded destination. Disabling an affiliate stops new earnings and prevents claims.
Claim fees
Open the affiliate’s Fees & claims tab. Available now shows earnings that have not been reserved for a payout. Pending payout shows claims in progress, and Paid out shows what has already been paid. Lifetime earned includes all of these. Check the balance and payout destination before claiming. The dashboard shows whether the balance is eligible and explains any restriction, including route minimums or temporary unavailability. If there is one eligible balance group, select Claim available fees. If there are several, select Choose fees to claim and pick an entry from Available buckets.Selecting a balance submits its full eligible amount immediately. There is no
separate confirmation step.
completed confirms the payout. See API claims to track it programmatically.
Give an affiliate read-only access
An affiliate can use its own dashboard to view earnings, orders, and payouts. Create a separate client key for this access:- In API Keys, select Create Key, choose Client, and set the mode to browser.
- Set Allowed origins to the affiliate dashboard’s origin, including the scheme and hostname but no path.
- Replace the default scopes with
affiliates:readonly. Set Affiliate pin to the exact affiliate ID, even though the field is labeled optional. - Create the key and give it to the affiliate along with its ID. Never share a server key.