Show for

Partner Onboarding

Embed merchant onboarding into your SaaS platform for a seamless experience.

Overview

As an Apt Commerce partner, you can onboard merchants directly from your platform. This guide covers the end-to-end flow from merchant creation to activation.

Onboarding Flow

Create merchant — Use the Partner API to create a sub-merchant with business details and processing requirements.
Collect KYC data — Gather beneficial owner information, business documentation, and bank account details through your UI or our hosted onboarding form.
Submit for review — Call the activate endpoint to submit the merchant for compliance review. Typical review time is 1-2 business days.
Monitor status — Poll the merchant status or subscribe to merchant.activated and merchant.review_required webhook events.
Go live — Once approved, the merchant can begin processing payments through your platform.

Hosted Onboarding

If you prefer not to build your own onboarding UI, generate a hosted onboarding link for the merchant:

const session = await apt.partner.merchants.createOnboardingSession(
  'merch_abc123',
  {
    return_url: 'https://yourplatform.com/merchants/abc123',
    theme: {
      primary_color: '#4F46E5',
      logo_url: 'https://yourplatform.com/logo.png',
    },
  }
);

// Redirect merchant to session.url

Webhook Events

merchant.createdNew sub-merchant record created.

merchant.submittedMerchant submitted for review.

merchant.activatedMerchant approved and ready to process.

merchant.review_requiredAdditional information needed from the merchant.

Next Steps

See the Partner API Reference for endpoint details, or apply to become a partner.