---
title: "Retrieve SubClient"
method: GET
path: "/v4/clients/{ClientID}/subclients/{SubClientID}"
tags: ["SubClient"]
---

# Retrieve SubClient

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

Retrieves a Client's SubClient Registration.

*For <<glossary:ISO>>s (Independent Sales Organization) only.*

## Path parameters

- `ClientID` string, required
- `SubClientID` string, required

## Response `200`

The SubClient registration is retrieved..

- RetrieveSubClientResponse
  - `SC` string — HTTP Status Code
  - `EC` string — Internal Error Code to help TabaPay trace the error.
  - `EM` string — Short Description of Error if Error Occurred.
  - `name` string — Company Name
  - `tin` string — [Taxpayer Identification Number](https://en.wikipedia.org/wiki/Taxpayer_Identification_Number).
  - `type` string — Company Type: - `LLC` - `LLP` - `C-Corp` - `S-Corp` - `SoleProprietor` - `Nonprofit` - `Charitable` - `Other`
  - `url` string — Company URL
  - `email` string — Valid 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 — Merchant Category Code
  - `mvv` string — Visa Merchant Verification Code - requires Visa registration
  - `maid` string — MasterCard Identification - requires MasterCard registration
  - `settlement` object — Settlement Accounts
    - `purchase` object, required — Purchase
      - `routingNumber` string, required — [ABA routing transit number](https://en.wikipedia.org/wiki/ABA_routing_transit_number)
      - `accountNumber` string, required — Account Number
    - `disbursement` object, required — Disbursement
      - `routingNumber` string, required — [ABA routing transit number](https://en.wikipedia.org/wiki/ABA_routing_transit_number)
      - `accountNumber` string, required — Account Number
    - `fee` object, required — Fee
      - `routingNumber` string, required — [ABA routing transit number](https://en.wikipedia.org/wiki/ABA_routing_transit_number)
      - `accountNumber` string, required — Account Number
    - `exception` object, required — Exception
      - `routingNumber` string, required — [ABA routing transit number](https://en.wikipedia.org/wiki/ABA_routing_transit_number)
      - `accountNumber` string, required — Account Number
    - `serviceType` string — Indicate the payment rail that TabaPay will utilize with the client/sub-client. Options are: - N - Next-Day ACH (Default) - S - Same-Day ACH - 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 <<glossary:RTP>> Credits
    - `RTP_RFPFee` string — Fixed fee charged on every <<glossary:RTP>> 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).

## 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)
