The Referrals API enables partners to refer merchants to Tyro directly from their own platform. Submit a merchant's details, the products they are interested in, and pricing in a single request, and Tyro takes it from there, while you stay across progress the whole way.
- Submit — Call the Referrals API with the merchant's details, products of interest, and agreed pricing.
- Track — Subscribe to referral notification events.
- Stay informed — As the referral moves through Tyro's approval workflow, surface the current status back to the merchant in your own platform.
Refer from your own platform
Submit a merchant lead directly via API — no manual steps or separate portals required.
End-to-end status tracking
Use the referralId returned on creation to follow a referral from received through to fully approved, and surface that progress back to the merchant in your own experience.
Refer at scale
Refer merchants programmatically via the API rather than one at a time.
- Supported merchants: Currently limited to merchants that are new to Tyro. Referring an existing Tyro merchant to add another site is not yet supported.
- Status updates: Track a referral by subscribing to referral notification events.
- Authentication: Referrals are submitted against your registered partner and channel agreement.
- Create Referral (POST /referrals): Submit a new merchant referral. Returns a
referralId. - Get Referral (GET /referrals/{referralId}): Retrieve the current status of a referral.