API Reference
Client PortalAPI StatusWebsite

Deregister an alias from an account

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

PayID (Australia)

De-register a PayID from the account. Once removed, the PayID is no longer associated with the account and cannot be used to receive payments until it is registered again.

Path Params
string
required

Identifies the account that the alias is associated with.
123456789

Query Params
string

The virtual account number to which the alias is linked. This is required when managing aliases for virtual accounts, and should be left empty when managing aliases for master accounts.
987654321

Body Params

The alias identity fields identifying which alias to delete.

Base for all alias request and response DTOs.

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 23 days ago

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

Updated 23 days ago