Sub-TPPs

These endpoints are for resellers using Token.io's licence to create, retrieve and delete sub-TPPs.

Create a sub-TPP

The POST /member/sub-tpps endpoint creates a new sub-TPP for a reseller.

SecurityBearer or BasicAuth
Request
Request Body schema: application/json
required
domain
required
string

The fully qualified domain name of the sub-TPP, also referred to as the 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.

Example: "somehost.example.com"
logo
string <byte> ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

This field specifies the image file containing the sub-TPP's logo as a byte array (click here for the JavaScript FileReader instance needed to convert the selected file into a byte array).

Example: "b0Y5cVl6aDc3RkE5blZyQ24yamlh"
required
object (member.Merchant)

Contains information about the merchant member.

name
required
string

The recognised business name or DBA of the sub-TPP.

Example: "Sub-TPP Business Ltd"
parentSubTppId
string (parentSubTppId)

The Token.io-generated identifier for the parent sub-TPP.

Example: "6f34h397-b29h-23b0-s30g-hkd0d2dk4k1s"
Responses
200

Successful response

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

post/member/sub-tpps
Request samples
application/json
{
  • "domain": "somehost.example.com",
  • "logo": "b0Y5cVl6aDc3RkE5blZyQ24yamlh",
  • "merchant": {
    },
  • "name": "Sub-TPP Business Ltd",
  • "parentSubTppId": "6f34h397-b29h-23b0-s30g-hkd0d2dk4k1s"
}
Response samples
application/json
{
  • "subTppId": "8d54f066-c14a-47c0-b58b-fec6b0ed6b4c"
}

Get sub-TPPs

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

SecurityBearer or BasicAuth
Request
query Parameters
page.offset
string

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.e. 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.
The offset is not visible to a user and should not be parsed and/or understood in any way.

Example: page.offset=LerV6Jmex
page.limit
required
integer <int32>
Default: 1

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

Example: page.limit=175
filter.byCompanyNames
Array of strings

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

Example: filter.byCompanyNames=["Company A","Company B","Company C"]
filter.byRegistrationDates
Array of strings

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

Example: filter.byRegistrationDates=["22-03-21","19-05-21","27-07-21"]
Responses
200

Successful response

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

get/member/sub-tpps
Request samples 
Response samples 
application/json
{
  • "offset": "LerV6Jmex",
  • "subTpps": [
    ]
}
Get sub-TPP information
The GET /member/sub-tpps/{subTppId} endpoint retrieves the details of the specified sub-TPP for a reseller.


SecurityBearer or BasicAuth 
Request 
path Parameters
subTppId
required
string
This id specifies the sub-TPP to be retrieved.


 
 Example:  8d54f066-c14a-47c0-b58b-fec6b0ed6b4c
Responses 
200
Successful response


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


get/member/sub-tpps/{subTppId}
Request samples 
Response samples 
application/json
{
  • "subTpp": {
    }
}
Delete a sub-TPP
The DELETE /member/sub-tpps/{subTppId} endpoint deletes an existing sub-TPP for a reseller.


SecurityBearer or BasicAuth 
Request 
path Parameters
subTppId
required
string
Specifies the sub-TPP to delete.


 
 Example:  8d54f066-c14a-47c0-b58b-fec6b0ed6b4c
Responses 
200
Successful response


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


delete/member/sub-tpps/{subTppId}
Request samples 
Response samples 
application/json
{ }
Get sub-TPP children
The GET /member/sub-tpps/{subTppId}/children endpoint retrieves the sub-TPP children for given sub-TPP.


SecurityBearer or BasicAuth 
Request 
path Parameters
subTppId
required
string
Specifies the sub-TPP for which the children are to be retrieved.


 
 Example:  8d54f066-c14a-47c0-b58b-fec6b0ed6b4c
Responses 
200
Successful response


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


get/member/sub-tpps/{subTppId}/children
Request samples 
Response samples 
application/json
{
  • "subTpps": [
    ]
}
➔ Next to Reports