Merchant Onboarding
Merchant onboarding is the process of registering a new merchant in the Convenient Checkout system. This guide outlines the required information, configuration steps, and best practices to ensure a smooth onboarding experience.
Onboarding begins when a prospective merchant submits the Convenient Checkout Engagement Form with business, treasury, and technical stakeholder details. See Merchant Intake & Onboarding for the business-level overview.
This onboarding process applies whether you're adopting V2 directly as a net-new merchant or migrating an existing V1 integration. Complete it first, then continue to the guide that matches your situation.
Requirements Checklistβ
Before starting, ensure you have the following:
Merchant Informationβ
Collect the following information from the merchant. See Capability Enablement Requirements for the detail behind each item.
- Merchant Name
- Merchant ID
- Merchant Group
- Customer Identifiers (e.g., patient ID, first/last name) β used to configure the Enterprise Settings identifier mapping for Enterprise Wallet
- Stripe Connect Account ID
- Language Preference
- Payment Method Types & Channels β which types (Card, Bank Account, HSA) and channels (Web form, Text, Email) to enable, and which vendor handles each
- Transaction Metadata β which transaction-level fields (e.g., order ID, order type) to attach to payments, for visibility in reports and webhook payloads
- Sender Information for Communication Channels β the sender identity used when agent-assisted text/email channels message a customer
- Webhook Endpoint β a publicly-accessible HTTPS endpoint for event notifications
- Reporting Destination β where ECG-delivered reports should land
Roles & Responsibilitiesβ
| Role | Responsibility |
|---|---|
| Merchant business/treasury/technical owners | Provide stakeholder details and merchant information via the Engagement Form |
| CCG onboarding team | Review the submission, provision the merchantId, and complete merchant configuration |
| Merchant's implementation team | Complete the integration steps for their chosen adoption path (direct-to-V2 or migration) |
Expected Outputsβ
By the end of this step, you should have:
- A provisioned
merchantId - Configured merchant settings (payment methods, enterprise settings, transaction metadata, sender information)
- Confirmation from CCG that merchant configuration is complete
Completion Criteriaβ
- All items in the Requirements Checklist above are complete
-
merchantIdhas been provisioned and confirmed by the CCG onboarding team - CCG onboarding team has reviewed and configured merchant settings as needed
Once complete, continue to your adoption path's integration steps: Direct-to-V2 Integration Steps or the V1 to V2 Migration Guide.