API Reference
Client PortalAPI StatusWebsite

Add or update an alias linked to an account

put
https://www.bankingcircleconnect.com/api/v1/accounts//aliases

PayID (Australia)

Add or update a PayID linked to an account. This endpoint can be used to either add a new PayID to a given account, or modify attributes such as the display name or other details without changing the underlying PayID identifier.

Path Params
string
required

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

Query Params
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.

string | null

A friendly display name for this alias.

boolean | null

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

string
enum
required
Allowed:
string
enum
required
Allowed:
string
required

The alias value registered with the service provider.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated 20 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 20 days ago