Support           API Reference           Log in to Dashboard →

Partner

These endpoints retrieve the list of members registered under the realm of the specified partner. You can also use these endpoints to enable/disable a specified member. Click an item below to expand/collapse its content.

page.offset | string – optional query parameter; 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

realmId | string – identifies a member created under the realm of the partner

type | string – specifies the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, BANK, CUSTOM, or EIDAS; default = INVALID

value | string – specifies the alias in type-appropriate format (ex. DOMAIN®www.yourCompany.com)

createdAtMs | string($string) – time since member was created in milliseconds; ex. 1 month (30 days) =2628000000000, 1 day (24 hours) = 8640000000, 1 hour = 36000000, 1 minute = 60000

id | string – member's Token-assigned memberId

profileName | string – name of the member's profile

offset | string – offset of the first item in the collection returned

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

 

memberId | string – member's Token-assigned identifier

empty object – no response data sent for HTTP 200 result

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

 

memberId | string – member's Token-assigned identifier

empty object – no response data sent for HTTP 200 result

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

 

 

 

 

 

 

 

 

 

Partner

These endpoints retrieve the list of members registered under the realm of the specified partner. You can also use these endpoints to enable/disable a specified member. Click an item below to expand/collapse its content.

page.offset | string – optional query parameter; 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

realmId | string – identifies a member created under the realm of the partner

type | string – specifies the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, BANK, CUSTOM, or EIDAS; default = INVALID

value | string – specifies the alias in type-appropriate format (ex. DOMAIN®www.yourCompany.com)

createdAtMs | string($string) – time since member was created in milliseconds; ex. 1 month (30 days) =2628000000000, 1 day (24 hours) = 8640000000, 1 hour = 36000000, 1 minute = 60000

id | string – member's Token-assigned memberId

profileName | string – name of the member's profile

offset | string – offset of the first item in the collection returned

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

 

memberId | string – member's Token-assigned identifier

empty object – no response data sent for HTTP 200 result

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

 

memberId | string – member's Token-assigned identifier

empty object – no response data sent for HTTP 200 result

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

 

 

 

 

 

 

 

 

 

Partner

These endpoints retrieve the list of members registered under the realm of the specified partner. You can also use these endpoints to enable/disable a specified member. Click an item below to expand/collapse its content.

page.offset | string – optional query parameter; 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

realmId | string – identifies a member created under the realm of the partner

type | string – specifies the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, BANK, CUSTOM, or EIDAS; default = INVALID

value | string – specifies the alias in type-appropriate format (ex. DOMAIN®www.yourCompany.com)

createdAtMs | string($string) – time since member was created in milliseconds; ex. 1 month (30 days) =2628000000000, 1 day (24 hours) = 8640000000, 1 hour = 36000000, 1 minute = 60000

id | string – member's Token-assigned memberId

profileName | string – name of the member's profile

offset | string – offset of the first item in the collection returned

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

 

memberId | string – member's Token-assigned identifier

empty object – no response data sent for HTTP 200 result

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

 

memberId | string – member's Token-assigned identifier

empty object – no response data sent for HTTP 200 result

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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

                           
COMPANY RESOURCES SOLUTIONS PRODUCTS

About

Careers

Press

Contact

Impressum

Connected Countries

Downloads

Blog

FAQ

PSPs

Merchants

Banks

Token Payments

Token Data

Token Compliance

© 2023 TOKEN, INC.    ALL RIGHTS RESERVED. POLICIES        MOBILE APP TERMS OF SERVICE   
 

 

 

 

                           
COMPANY RESOURCES SOLUTIONS PRODUCTS

About

Careers

Press

Contact

Impressum

Connected Countries

Downloads

Blog

FAQ

PSPs

Merchants

Banks

Token Payments

Token Data

Token Compliance

© 2023 TOKEN, INC.    ALL RIGHTS RESERVED. POLICIES        MOBILE APP TERMS OF SERVICE   

© 2023 TOKEN, INC.     ALL RIGHTS RESERVED.