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.

API Reference

Order aliases

POST/orders/account-aliases

PayID aliases (AUD accounts)

For AUD accounts, each alias is a PayID you choose. Pass them in identifications, one entry per alias, with count equal to the number of entries. Only email PayIDs are supported. You can't send identifications for accounts in other currencies.

{
  "accountId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "count": 2,
  "identifications": [
    { "payId": "ops@merchant.com" },
    { "payId": "sales@merchant.com" }
  ]
}

You can only register PayIDs on email domains that Volt has enabled for you. Contact Volt to set up your domains before placing your first order.

PayIDs rejected during registration don't fail the whole order. They're listed in failedIdentifications, so check it once the order completes.

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 — the order has completed.

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.

API Reference

Get alias order status

GET/orders/account-aliases/{id}

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.

API Reference