Integrations Overview

Before you begin your integration, it is important to identify your business model. This determines how you will configure your payment provider (PSP), which headers you will pass to the Yeeld API, and who is legally responsible for surcharging compliance.

1. Merchant Model

"I am the single business entity of record."

In this model, your business is the Merchant of Record (MoR) for all transactions. You use a single payment provider account to process payments for your own products or services.

• Who is it for? E-commerce stores, professional service firms, and standalone B2B businesses.
• PSP Configuration: You charge your primary provider account (e.g., a standard Stripe Secret Key).
• Yeeld Configuration: You do not need to pass an account header. Yeeld applies the surcharging rules associated with your primary API key.
• Compliance: You are responsible for any Mastercard Disclosure (Canadian-based businesses only) and regional compliance for your own entity.

2. Platforms & Marketplaces Model

"I provide software to other businesses who process payments."

In this model, you are a SaaS platform or marketplace (e.g., using Stripe Connect). You orchestrate payments for multiple sub-merchants, who are the actual Merchants of Record for their customers.

• Who is it for? Booking platforms, field service software, and multi-seller marketplaces.
• PSP Configuration: You typically use Destination Charges or Direct Charges to route funds to a specific sub-merchant's account.
• Yeeld Configuration: You must provide the Yeeld-Account header in every API call to ensure the surcharge is calculated based on that specific sub-merchant's location and settings.
• Compliance: Each sub-merchant must have a completed Mastercard Disclosure on file, and you are responsible for ensuring your software displays correct notices on their behalf.

Quick Comparison

Which Guide Should I Use?

• If you are a Merchant, follow our Standard Online Integration Guide.
• If you are a Platform or Marketplace, follow our Platform & Connect Integration Guide.