Onboarding

Submit a completed merchant application via API, automatically email the signer a secure link for e-signature, and track status through approval. After approval, use Entity Management to add locations and terminals.

How it works

  1. POST application data to create an application.

  2. The signer receives an email with a secure signing link.

  3. The API response includes applicationId and onboardingUrl for the same signing session.

  4. Track status using the applicationId or receive webhooks for status changes.

  5. After approval, proceed to Entity Management as needed

Key concepts

  • Partner MID: this is the partner’s own reference (their MID). Use partnerExternalId to carry it through Bead.

  • Signer: the person who will receive the email to complete and sign the application.

  • Fees and units: transactionRate.sellRate is expressed as a percentage (e.g., 3.50 = 3.50%). Per-item fees and fixed fees are in USD.

Endpoints at a glance

  • POST /merchant-onboarding/application

  • GET /merchant-onboarding/application/{applicationId}

  • GET /merchant-onboarding/application/{applicationId}/resume-signing

  • PUT /merchant-onboarding/{partnerId}/webhook

  • POST /merchant-onboarding/{applicationId}/feedback

Next

PreviousChangelogNextSubmit Application

Last updated