---
title: "Get sub-TPPs"
method: GET
path: "/member/sub-tpps"
tags: ["Sub-TPPs"]
---

# Get sub-TPPs

`GET /member/sub-tpps`

The `GET /member/sub-tpps` endpoint retrieves a list of all sub-TPPs for a reseller.

## Query parameters

- `page.offset` string
- `page.limit` integer, required
- `filter.byCompanyNames` string[]
- `filter.byRegistrationDates` string[]

## Response `200`

Successful response

- RetrieveSubTppsResponse
  - `offset` string — The offset of the first item returned in the collection.
  - `subTpps` MemberSubTpp[] — Contains each sub-TPP member onboarded by the reseller.
    - `childSubTppIds` string[] — The list of sub-TPP ids returned.
    - `createdAt` string, string — Represents the creation date for the sub-TPP, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format.
    - `domain` string — The fully qualified domain name of the sub-TPP, also referred to as an absolute domain name. This specifies an exact location in the tree hierarchy of the Domain Name System (DNS). It must include all domain levels, including the top-level domain and the root zone.
    - `id` string — The Token.io-generated `subTPPId` used by the reseller as `actingAs.refId` in token requests to identify the sub-TPP.
    - `logo` string, byte — Specifies the image file containing the sub-TPP's logo as a byte array. Click <a href="https://gist.github.com/taterbase/2784890" target="_blank">here</a> for the JavaScript `fromCharCode` function needed to convert the byte array to a UTF-8 string.
    - `memberId` string — The Token.io-generated member id for the reseller.
    - `merchant` MemberMerchant — Contains information about the merchant member.
      - `merchantJurisdiction` string, required — The 'merchantJurisdiction' field specifies the jurisdiction in which the merchant operates. Previously, this field was referred to as the 'domicile country'.
      - `legalEntityName` string, required — Full name of the merchant legal entity.
      - `companyRegistrationNumber` string, required — Company registration number of merchant legal entity.
      - `primaryUseCase` string, required — Merchant primary use case. Possible values include: AIS: Accounting package integration, AIS: Cash flow management, AIS: Credit risk analysis, AIS: Customer onboarding / verification, AIS: Personal finance management, PIS: eCommerce merchant payment, PIS: Funding an account, PIS: In store merchant payment, PIS: Paying a bill, PIS: Paying off debt
      - `iban` string, required — The IBAN of the bank where the payments are settled. The IBAN used will depend on the specific setup for each TPP/sub-TPP. </br>For example, this will be:<ul><li>The sub-TPP's IBAN for cases where settlement is to the merchant.</li><li>The TPP's IBAN when the sub-TPP settles directly with the TPP.</li><li>A proxy for jurisdictions involved in the transaction.</li></ul>Token.io checks the jurisdiction of the bank account and, where possible, confirms that the name on the account is valid; this name can be either the client's or the merchant's. </br>You must use a valid IBAN if you're testing in Sandbox.
      - `bic` string — BIC of merchant’s recipient bank account. You must use a valid IBAN if you're testing in sandbox.
    - `name` string — The recognised business name or DBA of the sub-TPP.
    - `parentSubTppId` string — The Token.io-generated identifier for the parent sub-TPP.
    - `restrictedCountries` string[] — A list of two-letter country codes in upper case (ISO 3166-1 alpha-2), in which this bank operates.
    - `status` 'INVALID_STATUS' | 'ACTIVATED' | 'REJECTED' | 'AWAITING_APPROVAL' | 'DEACTIVATED' — The status of the sub-TPP.
    - `statusReasonInformation` string — A human-readable description of the reason for the reported status, which may include a message from the bank. This value should not exceed 256 characters in length.
    - `mccCode` string — Merchant Category Code is a four-digit number that classifies the type of goods or service a business offers.
    - `updatedAt` string, string — The string representing the last update for the sub-TPP details, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format.

## Other responses

- `400` — The client specified an invalid argument
- `401` — The authorization information is missing or invalid
- `403` — Permission to access this endpoint is denied
- `404` — The requested entity, such as a sub-tpp, was not found
- `429` — Too many requests
- `500` — An unexpected or internal server error
- `501` — The operation was not implemented
- `503` — Service is unavailable
- `504` — Gateway has timed out

---

[API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/versions/5e8d6d2c24a1/schema)