SubClient v2

This version is split from the original /subclients endpoint, and can be used for the Verification Flow

Create SubClient v2 is a part of the SubClient v2 API and is a near real-time verificaiton and can be used for the Verification Flow to associate a userID and ledgerID(s) with the SubClientID.

Create a v2 SubClient with Verification Flow

Prerequisites

Endpoint

Send the Create SubClient API request to:

https://{FQDN}:{PORT}/v2/clients/{ClientID}/subclients/{SubClientID}

Key Fields

For the full request body and every field description, refer to Create SubClient API.

Provide the SubClient's business/card acceptor address in the request. If an eligible address field is omitted, TabaPay uses the corresponding value configured for your Client.

FieldDescription
addressAddress of the business, or of the contact when type is an individual.
nameName of the business contact.
cardTypesCard types enabled for push and pull.
userIDThe 22-character TabaPay user ID returned by Create User API.
mccMerchant Category Code.
useCaseBusiness vertical or use case.

Additional Key Fields

FieldDescription
addressAddress of the business, or of the contact when type is an individual.
nameName of the business contact.
cardTypesCard types enabled for push and pull.
settlement.purchaseLedger account that receives purchase settlement.
settlement.disbursementLedger account used for payouts.
settlement.feeLedger account for fees.
settlement.exceptionLedger account for exceptions and adjustments.
reserveAccountLedger account held in reserve.
userIDThe 22-character TabaPay user ID returned by Create User API.
mvvMerchant Verification Value.
maidMerchant Account Identifier, used by Mastercard.
isoIndependent Sales Organization identifier.

For more SubClient v2 fields, refer to Create SubClient API.

Use the SubClientID

After the SubClient is registered, append the SubClientID to your ClientID with an underscore when sending transactions:

https://{FQDN}:{PORT}/v1/clients/{ClientID}_{SubClientID}/transactions

Create accounts at the Client level rather than the SubClient level:

https://{FQDN}:{PORT}/v1/clients/{ClientID}/accounts

📘

SubClientID Applies to Transactions Only

Add the SubClientID for the Transaction API, not the Account API.


Did this page help you?