API Reference
GuidesAPI ReferenceRoadmapGo to DashboardSite >

Cancel an Alias of a Virtual Account

post
https://api.stage.localpayment.com/api/virtual-account//alias/cancel

This service allows you to deactivate an alias that you are no longer using.

Info

You must have at least one alias associated with your account at all times.

⚠️

The alias service for virtual accounts is not available in the Stage (sandbox) environment. This feature only works in Production. Please test your integration flows using Production credentials with caution.

Path Params
string
required

The unique identifier of the virtual account associated with the alias you want to cancel. This must be the exact externalId value of the virtual account.

Body Params
string
enum
required

The type of alias to be associated, can be E for email or P for phone number.

Allowed:
string
required

Value indicating the type of alias to be configured—either an email address or a phone number.

Responses

Updated 4 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago