Skip to main content
DELETE
Delete 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"

aliasKey
string
required

The alias key, as returned when the alias was created

Maximum string length: 64
Example:

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

Response

The alias was removed from the directory