Tokenized Account

These endpoints enable you to generate tokenized account id from the provided account details.

Create tokenized account

The POST /tokenized-accounts endpoint generates a tokenized account ID for the provided account details. The returned tokenized ID enables Third Party Providers (TPPs) to reference the account details in subsequent API calls.

SecurityBearer or BasicAuth
Request
Request Body schema: application/json
required
required
SepaAccount (object) or SepaInstantAccount (object) or FasterPaymentsAccount (object) or ElixirAccount (PLIbanAccount (object)) or (EUDomesticNonEuroAccount (EUIbanAccount (object) or BbanAccount (object) or ClearingNumberAccount (object))) or (EUDomesticNonEuroInstantAccount (EUIbanAccount (object) or BbanAccount (object) or ClearingNumberAccount (object))) or BankGiroAccount (object) or PlusGiroAccount (object) (AccountInformation)

The account information for the PSU or Business.

bankId
string

Identifier of the bank where the account belongs.

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

429

Too many requests

500

An unexpected internal server error occurred while processing the request.

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

post/tokenized-accounts
Request samples
application/json
{
  • "accountDetails": {
    },
  • "bankId": "ob-modelo"
}
Response samples
application/json
{
  • "tokenizedAccountId": "tai:4HoNxTfhn9EjwNnQmjGCsWsuYS7S:5zJAqBcE"
}

Get tokenized account

The GET /tokenized-accounts/{tokenizedAccountId} endpoint retrieves a single tokenized account.

SecurityBearer or BasicAuth
Request
path Parameters
tokenizedAccountId
required
string

The tokenized account id.

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 tokenized account, was not found

429

Too many requests

500

An unexpected internal server error occurred while processing the request.

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

get/tokenized-accounts/{tokenizedAccountId}
Request samples 
Response samples 
application/json
{
  • "accountDetails": {
    }
}
Delete tokenized account
The DELETE /tokenized-accounts/{tokenizedAccountId} endpoint deletes a single tokenized account.


SecurityBearer or BasicAuth 
Request 
path Parameters
tokenizedAccountId
required
string
The tokenized account id.


 
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 tokenized account, was not found


429
Too many requests


500
An unexpected internal server error occurred while processing the request.


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


delete/tokenized-accounts/{tokenizedAccountId}
Request samples 
Response samples 
application/json
{ }
➔ Next to Requests - for Payments v1 or AIS