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
- Request enablement from TabaPay Support or email [email protected].
- Complete the Verification Flow steps to obtain your
userIDandledgerIDvalues. - Any client handling sensitive card information is required to meet a specified level of PCI DSS (Payment Card Industry Data Security Standards).
- Send all requests in compact JSON format.
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.
| Field | Description |
|---|---|
address | Address of the business, or of the contact when type is an individual. |
name | Name of the business contact. |
cardTypes | Card types enabled for push and pull. |
userID | The 22-character TabaPay user ID returned by Create User API. |
mcc | Merchant Category Code. |
useCase | Business vertical or use case. |
Additional Key Fields
| Field | Description |
|---|---|
address | Address of the business, or of the contact when type is an individual. |
name | Name of the business contact. |
cardTypes | Card types enabled for push and pull. |
settlement.purchase | Ledger account that receives purchase settlement. |
settlement.disbursement | Ledger account used for payouts. |
settlement.fee | Ledger account for fees. |
settlement.exception | Ledger account for exceptions and adjustments. |
reserveAccount | Ledger account held in reserve. |
userID | The 22-character TabaPay user ID returned by Create User API. |
mvv | Merchant Verification Value. |
maid | Merchant Account Identifier, used by Mastercard. |
iso | Independent 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 OnlyAdd the SubClientID for the Transaction API, not the Account API.
Updated about 1 month ago
