Skip to main content
POST
Create an instant payment alias

Headers

ApiKey
string
required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId
string
required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment
enum<string>
required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:
live,
sandbox

Path Parameters

accountType
enum<string>
required

The account the aliases belong to: collection (receives instant payments) or transfer (pays them out)

Available options:
collection,
transfer
Example:

"collection"

Response

aliasKey
string
required

The alias key: the payment address to publish so payers can reach this account

Example:

"b9a4c2e1-7f3d-4e5a-9c8b-1d2e3f4a5b6c"

aliasType
enum<string>
required

The alias type. HUB2 creates SHID aliases, whose key the directory generates

Available options:
SHID,
MCOD,
MBNO
accountType
enum<string>
required

The account the alias names

Available options:
collection,
transfer
isPrimary
boolean
required

Whether HUB2 uses this alias as the account's own leg on the payments it initiates

created
boolean
required

False when the account already held a SHID alias: the directory holds one SHID per account and returns the existing one rather than creating a second