Managing aliases
Activate, deactivate, and close aliases, and receive lifecycle notifications.
Once aliases exist, you can temporarily disable them, re-enable them, or permanently close them. All management calls are mutations and require an Idempotency-Key header.
Activate and deactivate
Deactivating an alias stops it from accepting incoming payments without closing it. Deactivation is reversible — you can activate the alias again at any time. The request is rejected if the alias is already in the requested state, or if it has been closed.
Close an alias
Closing an alias marks it as closed immediately. Closing is permanent — a closed alias cannot be reopened or used to receive further payments.
The optional request body can override the webhook destination for the close notification — see .
A closed alias is terminal. Attempting to close an already-closed alias is rejected.
Notifications
Closing an alias emits an alias closed webhook on the Account lifecycle channel — see for the payload, and for setup and overrides.
How is this guide?
Last updated on