SubTpp
These endpoints are for resellers using Token's licence to create, retrieve and delete sub-TPPs. Click an item below to expand/collapse its content.
page.offset | string – query parameter, optional; zero-based offset of the first item in the collection to return
page.limit | integer($int32) – required query parameter; maximum number of records to return; default = 1
offset | string – offset of the first item in the collection returned
createdAt | string($string) – string representing the creation date for the sub-TPP in ISO 8601 date format (ex. YYYY-MM-DDhh:mm:ss)
domain | string – fully qualified domain name of the sub-TPP; also referred to as an absolute domain name; specifies an exact location in the tree hierarchy of the Domain Name System (DNS); must include all domain levels, including the top-level domain and the root zone (ex. somehost.example.com)
domicileCountry | string – the country in which the TPP maintains its permanent legal business address
id | string – Token-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 here for the JavaScript fromCharCode function needed to convert the byte array to a UTF-8 string.
mcccode | string – when provided, specifies the sub-TPP's merchant category code, a 4-digit code appended with a brand, where -V = Visa, -M = Mastercard, and -O = other (e.g., 5699-V represents a merchant in the Clothing Stores category that accepts Visa; 5699-V,M means a merchant in the same category accepts both Visa and MasterCard). Every transaction processed by the card networks is assigned a merchant category code (MCC). MCCs are used by card issuers to categorize, track or restrict certain types of purchases. MCC can affect the interchange rate and credit card processing fees, as well as how customers are rewarded for purchases they make with their credit card.
memberId | string – Token-generated member identifier for the reseller
name | string – recognised business name or DBA of the sub-TPP
status | string – available values: INVALID_STATUS, ACTIVATED, REJECTED, AWAITING_APPROVAL or DEACTIVATED; default = INVALID_STATUS
updatedAt | string($string) – string representing last update in ISO-8601 format (ex. YYYY-MM-DDhh:mm:ss)
400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument
401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation
403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank
404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found
429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)
500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.
501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank
503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry
504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete
domain | string – fully qualified domain name of the sub-TPP; also referred to as an absolute domain name; specifies an exact location in the tree hierarchy of the Domain Name System (DNS); must include all domain levels, including the top-level domain and the root zone (ex. somehost.example.com)
domicileCountry | string – name of the country in which the TPP maintains its permanent legal business address
logo | string($byte) – 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)
mcccode | string – when provided, specifies the sub-TPP's merchant category code, a 4-digit code appended with a brand, where -V = Visa, -M = Mastercard, and -O = other (e.g., 5699-V represents a merchant in the Clothing Stores category that accepts Visa; 5699-V,M means a merchant in the same category accepts both Visa and MasterCard). Every transaction processed by the card networks is assigned a merchant category code (MCC). MCCs are used by card issuers to categorize, track or restrict certain types of purchases. MCC can affect the interchange rate and credit card processing fees, as well as how customers are rewarded for purchases they make with their credit card.
name | string – recognised business name or DBA of the sub-TPP
subTppId | string – Token-generated identifier for the sub-TPP used by the reseller as actingAs.refId in token requests
400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument
401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation
403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank
404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found
429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)
500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.
501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank
503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry
504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete
subTppId | string – required in path; specifies the sub-TPP to be retrieved
createdAt | string($string) – string representing the creation date for the sub-TPP in ISO 8601 date format (ex. YYYY-MM-DDhh:mm:ss)
domain | string – fully qualified domain name of the sub-TPP; also referred to as an absolute domain name; specifies an exact location in the tree hierarchy of the Domain Name System (DNS); must include all domain levels, including the top-level domain and the root zone (ex. somehost.example.com)
domicileCountry | string – the country in which the TPP maintains its permanent legal business address
id | string – Token-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 here for the JavaScript fromCharCode function needed to convert the byte array to a UTF-8 string.
mcccode | string – when provided, specifies the sub-TPP's merchant category code, a 4-digit code appended with a brand, where -V = Visa, -M = Mastercard, and -O = other (e.g., 5699-V represents a merchant in the Clothing Stores category that accepts Visa; 5699-V,M means a merchant in the same category accepts both Visa and MasterCard). Every transaction processed by the card networks is assigned a merchant category code (MCC). MCCs are used by card issuers to categorize, track or restrict certain types of purchases. MCC can affect the interchange rate and credit card processing fees, as well as how customers are rewarded for purchases they make with their credit card.
memberId | string – Token-generated member identifier for the reseller
name | string – recognised business name or DBA of the sub-TPP
status | string – available values: INVALID_STATUS, ACTIVATED, REJECTED, AWAITING_APPROVAL or DEACTIVATED; default = INVALID_STATUS
updatedAt | string($string) – string representing last update in ISO-8601 format (ex. YYYY-MM-DDhh:mm:ss)
400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument
401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation
403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank
404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found
429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)
500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.
501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank
503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry
504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete
subTppId | string – required in path; specifies the sub-TPP to delete
empty | object – no data returned in successful response
400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument
401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation
403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank
404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found
429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)
500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.
501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank
503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry
504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete