Activate / Deactivate VA Alias

Toggles the is_active status of an existing VA Alias.

Failure conditions (all return statusCode: 900 with the description below):

ConditionStatus Description
Alias already activeVA Alias is already active
Alias already inactiveVA Alias is already inactive
Invalid va_codeva_code is mandatory and must be 5 alphanumeric characters
Invalid va_aliasva_alias is mandatory and must be alphanumeric (max 7 chars)
Missing or invalid is_active flagis_active flag is mandatory and must be boolean (true/false)
VA Code does not existVA Code does not exist for this merchant
VA Alias does not existVA Alias does not exist for this VA Code
Activation/Deactivation failedVA Alias activation/deactivation failed
Internal server errorInternal Server Error
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

5-character alphanumeric VA Code.

string
required

Alphanumeric alias (max 7 chars).

boolean
required

true to activate, false to deactivate.

Response

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