Accounts APIAliases

Close alias

POST
/account-aliases/{aliasId}/close

Permanently closes the specified alias. A closed alias cannot be reopened or used for further transactions.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

aliasId*string

Unique identifier of the alias to be closed.

Formatuuid

Header Parameters

Idempotency-Key*string

It helps preventing duplicates in your POST requests. It is recommend using a UUID for the key, however you may use any other unique identifier you choose.

Lengthlength <= 160
X-Volt-Api-Version*1

Version of the API used. Currently, version 1 is the only version.

Value in1

Request Body

application/json
  1. body
communication?

Response Body

Alias successfully closed.

Example Request
curl -X POST 'https://accounts.sandbox.volt.io/account-aliases/497f6eca-6276-4993-bfeb-53cbbbba6f08/close' \  -H 'Idempotency-Key: 85136c79cbf9fe36bb9d05d0639c70c265c18d37' \  -H 'X-Volt-Api-Version: 1' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty

Change state of alias PATCH

Marks the specified alias as active or inactive.

Get alias details GET

Next Page