SubClient v4 is used to board businesses that have previously, or will complete a verification process outside of TabaPay. When a SubClient is created, TabaPay associates the registration with a unique SubClientID that can be used for supported SubClient-level payment requests.

Note: For near real-time onboarding, refer to SubClient v2.

✋
Request to enable at TabaPay Support or [email protected].

Popular Use Cases

Merchant Boarding: Register businesses as SubClients so they can process payments through your platform.
Platform Payments: Separate transaction activity, settlement, and reporting for each business operating on your platform.

When to Use SubClient v4

Use SubClient v4 when the business or individual is verified outside of TabaPay.

Use SubClient v2 when you are ready for near-real time onboarding, or use TabaPay's Verification Flow to verify the business or individual through the User, Verification, and Ledger APIs.

Version	Verification
SubClient v4	Business or individual is verified outside of TabaPay.
SubClient v2	Near real-time onboarding for business or individuals. You may use TabaPay's Verification Flow.

SubClient v4 APIs

Use the following APIs to manage the SubClient registration:

All SubClient v4 endpoints use:

/v4/clients/{ClientID}/subclients/{SubClientID}

SubClient v4 Flow

SubClient v4 allows you to board businesses that complete verification outside of TabaPay. The boarding process includes merchant verification, compliance review, SubClient registration, and payment processing.

Collect Merchant Information: Gather the business name, Taxpayer Identification Number (TIN), address, contact information, Merchant Category Code (MCC), and payment use case.
Verify the Business: Confirm the required KYB/KYC verification process through your existing process or a third-party provider.
Complete Compliance Review: Provide TabaPay with any additional boarding information required for compliance and network approval. This may include:
- Business and payment use case details
- Transaction types, card networks, and processing limits
- Settlement and bank account information
- Applicable network approvals
Create SubClient: Send the Create SubClient v4 API request with the required merchant information and configuration.

Fields that may be included for onboarding that do not get passed in the API will be captured during the compliance review.

Process Transactions: After the SubClient is approved and enabled, use its SubClientID in supported Create Transaction API requests.

For additional boarding requirements, refer to Boarding Bank or ISO Customers.

How SubClient v4 Works

The following steps will show you how to Create a v4 SubClient

Create a SubClient

Send the Create SubClient v4 API request to register a SubClient.

Endpoint

POST https://{FQDN}:{PORT}/v4/clients/{ClientID}/subclients/{SubClientID}

The SubClientID is a 4, 6, or 8-digit identifier based on your TabaPay configuration. Contact TabaPay if you need to confirm the required format for your Client.

Required Fields

The following fields are required when creating a SubClient v4 registration:

Field	Description
`name`	Company name.
`tin`	9-digit Taxpayer Identification Number, such as an EIN or SSN.
`type`	Business entity type.
`email`	Contact email address.
`address`	Address for the SubClient.
`phone`	Contact phone information.
`mcc`	4-digit Merchant Category Code.

The Create SubClient API also supports additional configuration for settlement accounts, fees, reserves, business owners, and network-specific identifiers. Refer to the Create SubClient v4 API for the complete request schema. :contentReference[oaicite:1]1

Example Request

{
  "name": "Acme Holdings LLC",
  "tin": "123456789",
  "type": "LLC",
  "url": "https://acme.example",
  "email": "[email protected]",
  "address": {
    "line1": "500 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "zipcode": "94105",
    "country": "840"
  },
  "phone": {
    "countryCode": "1",
    "number": "4155551234"
  },
  "mcc": "5814"
}