v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Sub-TPPs

Get sub-TPPs

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

get/member/sub-tpps

Query parameters

page.offsetstring

The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (<i>i.e.</i> this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data. <br/>The offset is not visible to a user and should not be parsed and/or understood in any way.

page.limitinteger required

Example:175

The maximum number of records to return. This must be less than 200.

filter.byCompanyNamesstring[]

Filters the sub-TPPs by the list of company names submitted.

[
  "[\"Company A\",\"Company B\",\"Company C\"]"
]

filter.byRegistrationDatesstring[]

Filters the sub-TPPs by the list of registration dates submitted.

[
  "[\"22-03-21\",\"19-05-21\",\"27-07-21\"]"
]

Response

Successful response

offsetstring

The offset of the first item returned in the collection.

Example response

{
  "offset": "LerV6Jmex",
  "subTpps": [
    {
      "childSubTppIds": [
        "[\"8d54f066-c14a-47c0-b58b-fec6b0ed6b4c\",\"3d46h823-g02s-20m5-k19c-kes4ekkc2p5x\",\"0c55fwgs-s1e2-dloa-0j36-sat2b9kw4s8g\"]"
      ],
      "createdAt": "2022-09-22T17:00:00.000Z",
      "domain": "somehost.example.com",
      "id": "8d54f066-c14a-47c0-b58b-fec6b0ed6b4c",
      "memberId": "m:213xyzabc3453434",
      "merchant": {
        "merchantJurisdiction": "DE",
        "legalEntityName": "Test Merchant Entity Name",
        "companyRegistrationNumber": "123456789",
        "primaryUseCase": "AIS: Accounting package integration",
        "iban": "DE0000000000000000000",
        "bic": "BOFIIE2D"
      },
      "name": "Sub-TPP Business Ltd",
      "parentSubTppId": "6f34h397-b29h-23b0-s30g-hkd0d2dk4k1s",
      "restrictedCountries": [
        "DE",
        "FR",
        "GB"
      ],
      "status": "ACTIVATED",
      "statusReasonInformation": "This sub-TPP has been activated.",
      "updatedAt": "2022-09-22T17:00:00.000Z"
    }
  ]
}