We've launched a new version of our Dev Docs and API Reference! View here →

Account on File

These endpoints allow you to create and manage an Account on File from bank account details. The Account on File can then be used in other API requests instead of sending the full account details.

Create an Account on File

Creates an Account on File from the provided bank account details. This can be used by Third Party Providers (TPPs) in future API requests to reference the account without resending the full account information.

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"
}

Retrieve an Account on File

Retrieves an Account on File using its tokenizedAccountId.

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 an Account on File

Deletes an Account on File. After deletion, the tokenizedAccountId can no longer be used to reference the associated account details in API requests.

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
{ }