Ordering aliases
Order new aliases for a Volt Account, track the order, and fetch the resulting aliases.
Alias ordering is asynchronous: the API accepts your order and returns an order identifier immediately, and the aliases become available once the order completes.
Placing an order
Order aliases for a Volt Account by specifying the account and the number of aliases to create (between 1 and 1000). You can optionally override the webhook destination for this order via a communication field. The response returns the created order identifier, and the Location header points to the order status resource.
Tracking the order
The order is the unit that completes — individual aliases are not addressable until it reaches a terminal state. The order reports how many aliases were requested and how many have completed so far, along with its status:
- PROCESSING — aliases are still being provisioned.
- COMPLETED — all requested aliases have been created.
- FAILED — the order could not be completed.
Once the order is COMPLETED, follow the aliases link on the order to fetch the aliases it created.
Fetching the aliases
List the aliases for an account — optionally filtered by the order they were created with — or retrieve a single alias by its id. Each alias carries its identifiers, currency, and status.
List of aliases for an account
Get alias details
Related
- — activate, deactivate, close, and webhooks.
- — end-to-end walkthrough.
How is this guide?
Last updated on