--- title: "Retrieve SubClient" method: GET path: "/v2/clients/{ClientID}/subclients/{SubClientID}" tags: ["SubClient"] --- # Retrieve SubClient `GET /v2/clients/{ClientID}/subclients/{SubClientID}` Retrieves a Client's SubClient Registration. *For <>s (Independent Sales Organization) only.* This endpoint is split from the original `/subclients` endpoint. ## Path parameters - `ClientID` string, required - `SubClientID` string, required ## Response `200` The SubClient registration is retrieved.. - RetrieveSubClient2Response - `SC` integer — [HTTP Status Code](https://developers.tabapay.com/reference/http-status-codes#/) - `EC` string — Internal Error Code. This is used to help TabaPay team members trace an error. - `EM` string — Short description of the error if an error occurred. - `name` string - `tin` string — [Taxpayer Identification Number](https://en.wikipedia.org/wiki/Taxpayer_Identification_Number) - `type` 'LLC' | 'LLP' | 'C-Corp' | 'S-Corp' | 'SoleProprietor' | 'Nonprofit' | 'Charitable' | 'NaturalPerson' | 'Other' - `url` string - `email` string, email — Email Address - `address` Address — Address - `line1` string, required — Address Line 1 - `line2` string — Address Line 2 *Optional* - `city` string, required — City - `state` string, required — State Code [State Code](https://developers.tabapay.com/reference/us-state-codes#/) must be a valid 2-character code if `country` is [840](https://developers.tabapay.com/reference/country-codes#/) or [Canadian 2-char code](https://developers.tabapay.com/reference/canadian-province-codes#/) if [124](https://developers.tabapay.com/reference/country-codes#/). - `zipcode` string, required — Zip Code If `country` is `840`, `zipcode` must be 5 or 9 digits. If country is `124`, `zipcode` must be in the *A1A 1A1* format. Zip codes from other countries will not be checked. - `country` string — [Country Code](https://developers.tabapay.com/reference/country-codes#/) *Optional. Default is `840`* - `phone` Phone — Phone *object* - `countryCode` string — 1-3 digit Country Calling Code *Optional.* Default is `1`. - `number` string, required — Phone Number. For phone numbers with `countryCode` equal to `1` (or blank), provide a 10-digit phone number. For all `countryCodes`, other than `1`, a 4-14 digit phone number is accepted. - `mcc` string - `mvv` string - `maid` string - `evv` string - `userID` string — TabaPay user identifier - `iso` string - `useCase` string - `transactionTypes` Subclient2TransactionTypes - `push` boolean — Push transaction enabled - `pull` boolean — Pull transaction enabled - `identification` Subclient2Identification - `type` 'SSN' | 'GovernmentID' | 'Passport' | 'EIN' - `country` string — ISO-4217 numeric currency code - `number` string — A unique ID number issued by a government or organization. - `cardTypes` Subclient2CardTypes - `push` Subclient2CardTypesDirection - `debit` boolean — Debit card type enabled - `credit` boolean — Credit card type enabled - `prepaid` boolean — Prepaid card type enabled - `pull` Subclient2CardTypesDirection - `debit` boolean — Debit card type enabled - `credit` boolean — Credit card type enabled - `prepaid` boolean — Prepaid card type enabled - `visa` Subclient2NetworkConfig - `push` Subclient2NetworkDirection - `enabled` boolean — Network enabled flag - `mccOverride` string - `pull` Subclient2NetworkDirection - `enabled` boolean — Network enabled flag - `mccOverride` string - `mastercard` Subclient2NetworkConfig - `push` Subclient2NetworkDirection - `enabled` boolean — Network enabled flag - `mccOverride` string - `pull` Subclient2NetworkDirection - `enabled` boolean — Network enabled flag - `mccOverride` string - `discover` Subclient2NetworkConfig - `push` Subclient2NetworkDirection - `enabled` boolean — Network enabled flag - `mccOverride` string - `pull` Subclient2NetworkDirection - `enabled` boolean — Network enabled flag - `mccOverride` string - `settlement` Subclient2Settlement - `purchase` Subclient2SettlementAccount - `routingNumber` string — [ABA routing transit number](https://en.wikipedia.org/wiki/ABA_routing_transit_number) - `accountNumber` string - `ledgerID` string — TabaPay ledger identifier - `disbursement` Subclient2SettlementAccount - `routingNumber` string — [ABA routing transit number](https://en.wikipedia.org/wiki/ABA_routing_transit_number) - `accountNumber` string - `ledgerID` string — TabaPay ledger identifier - `fee` Subclient2SettlementAccount - `routingNumber` string — [ABA routing transit number](https://en.wikipedia.org/wiki/ABA_routing_transit_number) - `accountNumber` string - `ledgerID` string — TabaPay ledger identifier - `exception` Subclient2SettlementAccount - `routingNumber` string — [ABA routing transit number](https://en.wikipedia.org/wiki/ABA_routing_transit_number) - `accountNumber` string - `ledgerID` string — TabaPay ledger identifier - `serviceType` 'N' | 'S' | 'R' — Includes: - N: Next Day - S: Same Day - R: RTP - `fees` Fees — Set fees for this subclient. For more information refer to: [Fees for Sub-Clients during Boarding](https://developers.tabapay.com/docs/fees-for-sub-clients-during-boarding) - `type` string, required — Type of fee - Merchant Discount Rate or Interchange Plus Plus. Values must be one of the following: MDR or IPP. - `monthlyMinimumProcessingFee` string — Merchant minimum fee if total processing fee is below the contract stated min - `authorizationFee` string — Authorization (no funds movement) fee; Charged on failed purchases as well. - `AVSFee` string — Address Verification Fee - `deleteFee` string — Fee charged with every successful Delete API request - `MIDFee` string — Fixed fee for MID being active - `purchaseFeeFixed` string — Fixed fee for successful purchases - `purchaseFeeVariable` string — Variable fee for successful purchases ( % ) So 5% will be 0.0500 - `purchaseFeeCap` string — Cap on Purchase fee. Applies to successful purchases. - `disbursementFeeFixed` string — Fixed fee for successful disbursements - `monthlySubClientFee` string — Fixed sub-client fee per month - `chargebackFee` string — Fee charged on every chargeback - `retrievalFee` string — Fee charged on every successful Retrieve Account - `batchFee` string — Fee charged for batches that are run - `ACHNextDayCreditFee` string — Fixed fee charged on every ACH Next Day Credit transaction - `ACHNextDayDebitFee` string — Fixed fee charged on every ACH Next Day Debit transaction - `ACHSameDayCreditFee` string — Fixed fee charged on every ACH Same Day Credit transaction - `ACHSameDayDebitFee` string — Fixed fee charged on every ACH Same Day Debit transaction - `ACH_NSFFee` string — Fixed fee charged for every ACH NSF - `ACHFraudFee` string — Fixed fee charged on every ACH fraudulent transaction - `ACHAdminReturnFee` string — Fixed fee charged on every ACH return - `RTPCreditFee` string — Fixed fee charged on every <> Credits - `RTP_RFPFee` string — Fixed fee charged on every <> Request for Payment - `cardTypeFee` CardTypeFee — Card Type Fee - `intlCreditFixed` string — Fixed fee for successful international credit card transactions - `intlCreditVariable` string — Variable fee for successful international credit card transactions ( % ) - `intlDebitFixed` string — Fixed fee for successful international debit card transactions - `intlDebitVariable` string — Variable fee for successful international debit card transactions ( % ) - `creditSurchargeFixed` string — Fixed fee for credit card surcharges - `creditSurchargeVariable` string — Variable fee for credit card surcharges (%) - `amexFixed` string — Fixed fee for successful American Express transactions - `amexVariable` string — Variable fee for successful American Express transactions ( % ) - `3DSFee` string — Fixed fee for every 3DS invocation - `accountUpdaterFee` string — Fixed fee for each account updater request - `reserveAccount` ReserveAccount — Set reserve account for this subclient. If you add a reserve account, you will need a routing number and an account number. - `routingNumber` string, required — Routing number for the reserve account (9 digits). *Required if account number is present.* - `accountNumber` string, required — Account number for the reserve account (4-17 digits). *Required if routing number is present.* - `calculationsCurrencyCode` string — ISO-4217 3 digit currency code (3 digits). [Currency Code](https://developers.tabapay.com/reference/country-codes). Default: 840 (USD). - `calculationsVariable` string — Percentage of amount to be held daily. Format: xxx.xxxx (e.g. 5% is written as 0.05). - `calculationsFixed` string — Amount after which hold on reserve is released (same format as amount). [Currency Amount](https://developers.tabapay.com/reference/currency-numbers) - `calculationsNoOfDays` string — Number of days after which amount held is released (1-4 digits). - `businessOwners` BusinessOwners — Individuals that own at least 25% of the entity, or the largest owner if no one owns at least 25%. **Note: If you plan to add/remove/modify any owner information in the future, you will need re-submit all existing information to the update SubClient API. It is recommend that you store the owner information for this purpose.** - `businessOwner1` BusinessOwner, required — Additional individuals that own at least 25% of the entity. - `firstName` string, required — First name - `middleName` string — Middle name - `lastName` string, required — Last name - `dateOfBirth` string, required — Date of birth with the format: YYYYMMDD. Owner must be at least 18 years old. - `businessOwner2` BusinessOwner — Additional individuals that own at least 25% of the entity. - `firstName` string, required — First name - `middleName` string — Middle name - `lastName` string, required — Last name - `dateOfBirth` string, required — Date of birth with the format: YYYYMMDD. Owner must be at least 18 years old. - `businessOwner3` BusinessOwner — Additional individuals that own at least 25% of the entity. - `firstName` string, required — First name - `middleName` string — Middle name - `lastName` string, required — Last name - `dateOfBirth` string, required — Date of birth with the format: YYYYMMDD. Owner must be at least 18 years old. - `businessOwner4` BusinessOwner — Additional individuals that own at least 25% of the entity. - `firstName` string, required — First name - `middleName` string — Middle name - `lastName` string, required — Last name - `dateOfBirth` string, required — Date of birth with the format: YYYYMMDD. Owner must be at least 18 years old. - `ipAddress` string, ipv4 - `dbaName` string — Doing Business As (DBA) - `payoutSchedule` string ## Other responses - `404` — SubClient Registration not found. --- [API](https://skmtc.dev/tabapay/apis/tabapay-apis.md) · [All operations](https://skmtc.dev/tabapay/apis/tabapay-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tabapay/tabapay-apis/revisions/154fa3d585cf/schema)