The Introduction gives a brief overview about events Yoki notifies a merchant via webhooks. Full API reference can be found here https://api-rps.yoki.fi/swagger. Yoki API uses Stripe API terminology where possible to ease onboarding and integration. Let's see what objects are used in Yoki API:
Last updated
| Object | Description |
|---|---|
Merchant
This is company receiving payments. Normally, one merchant corresponds to one client, but there can be situations (when client is a marketplace or payment system), when client wants to manage multiple merchants via API. In this case an Organization is created as an umbrella object for multiple merchants.
Organization
High-level organization that can create multiple merchants. It has separate payment fee and API key.
Product
Product describes specific goods or services merchants offer to their customers. You can also think about this as set of characteristics customers buy. For example, you can offer Standard and Premium version of your service. In this case, each would be a separate product.
Price
Prices define cost, currency (for now only USD is supported) and payment terms. For instance, you can offer Standard product for $5/month or $50/year. So, there will be two prices for one Product. A product can have multiple prices.
Payment contract
Payment contract defines how customers pay certain Price onchain. For instance, for a price $5/month, there could be two payment contracts – one to pay in USDT and another in USDC.
