Add or update an alias linked to an account

put

https://www.bankingcircleconnect.com/api/v1/accounts/{accountNumber}/aliases

Path Params

accountNumber

string

required

The 9-digit account identifier for the intended account, or the master account if targeting a virtual account. 123456789

Query Params

virtualAccountNumber

string

If targeting a virtual account, this must be filled with the 9-digit virtual account number. The regular accountNumber parameter must be set to the master account for the virtual account. 987654321

Body Params

Contains the payload that will be used for creating or updating an alias.

name

string | null

A friendly display name for this alias.

active

boolean | null

Whether the alias should be active. Leave null to keep the current state. Set to false to deactivate an existing alias.

service

string

enum

required

Allowed:

type

string

enum

required

Allowed:

value

string

required

The alias value registered with the service provider.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json

202Accepted

400Bad Request

404Not Found

429Too Many Requests

500Internal Server Error