Onboard Merchant/Partner
Last updated
Last updated
Before importing a merchant, you must first authenticate.
Initiate the creation of a new merchant account using this API endpoint:
Example request body:
Example response:
The response contains:
merchantId
Unique identifier for the merchant account
username
The username required for merchants to access the Bead Portal
password
The password required for merchants to access the Bead Portal
onboardingPageUrl
: A unique page created for the merchant to complete their onboarding process.
Note: username
and password
currently return no values, to be updated in a future version.
After receiving the response, redirect the user to the onboardingPageUrl
where the merchant will be guided to complete their Bead onboarding process:
Accept Terms of Use and Privacy agreements
Complete their business registration (KYB)
Complete KYC for all owners with 25%+ ownership
Upon KYB/KYC approval, merchant receives email to connect their bank account
Access page from email link
Enter bank account info
Upon successful bank account connection, the merchant account is onboarded and ready to accept Bead payments.
If redirection to the onboardingPageUrl
is not possible, you can send the merchant their onboarding link. If the KYB process is not completed within 1 hour, Bead will email the merchant at the email provided in the request body.
Once the merchant account is fully onboarded, the next step is to create a Terminal from which payments can be initiated.
Before creating a partner, you must first authenticate.
Initiate the creation of a new partner account using this API endpoint:
Example request body:
Example response:
The response contains:
id
Unique identifier for the partner account
partnerType
reseller
integrator
paymentGatewayFees
feeFactor
The total fee percentage added to transactions (Example: if the partner's total percentage-based transaction fee is 2%, feeFactor
is represented as 0.02
)
fixedFee
The total fixed fee added to transactions (Example: if the partner's total fixed transaction fee is $0.10, fixedFee
is represented as 0.10
)
/Merchants/import
/Partners
reseller
, integrator