A SubClient is a sub-merchant boarded under your TabaPay Client level. Each SubClient has a unique SubClientID associated with its own Merchant Identifier (MID). The SubClientID and MID identify SubClient activity, including transaction settlement and reporting, for each merchant on your platform.

Use the SubClient API to create and manage these registrations, then include the SubClientID in your Create Transaction API requests.

Popular Use Cases

• Independent Sales Organization (ISO) boarding: Register merchants under your ISO so each one settles and reports against its own MID.
• Platform and marketplace payments: Separate settlement accounts, fees, and exceptions for each business operating on your platform.
• Verified user accounts: Link a verified user and their ledger accounts to a SubClient, then transact on their behalf.

Choosing SubClient v2 or v4

Both versions create a SubClientID. Choose the version based on your desired onboarding speed, or how the business or individual is verified.

• SubClient v2 is a separate endpoint split from the original /subclients endpoint. It works alongside the User, Ledger, and Verification APIs.

SubClient v2 Workflow

SubClient v2 creation is near real-time and the final step of the Verification Flow. You can complete the preceding steps first, since the request depends on identifiers those steps return.

Note: If your business or individual customer has already completed verification through TabaPay or an approved third-party provider, you can proceed directly to Create SubClient v2 API without repeating the Verification Flow.

1. Create User API returns a userID for the business or individual.
2. Create Document APIAPI (Optional)
3. Create Verification API runs KYB or KYC against that user.
4. Create Ledger API returns a ledgerID for each account you need.
5. Create SubClient API ties the userID and ledgerID values to a SubClientID.

For request and response details on every step, refer to Verification Flow.

SubClient v4 Workflow

Use SubClient v4 to board businesses or individuals that have completed verification outside of TabaPay. The SubClient registration includes the merchant information and payment configuration needed to process transactions through your platform.

1. Verify the business or individual through your existing verification process or a third-party provider.
2. Create SubClient: Send the Create SubClient v4 API request with the required merchant information and payment configuration.
3. Retrieve SubClient (Optional): Use the Retrieve SubClient v4 API to review the registered SubClient information.
4. Create Transaction: Include the SubClientID in supported Create Transaction API requests to process payments for the SubClient.

For required fields, request examples, and SubClient management, refer to SubClient v4.

Recipes

More Resources

• Verification Flow: Complete KYB and KYC through the API before creating a SubClient.
• KYB for boarding Sub-Merchants: Verification requirements for sub-merchants.
• Boarding Bank or ISO Customers: Submit a boarding request.
• Boarding Checklist: Items to configure before going live.