Update a transaction-context alias

Request

Updates the human-readable alias for a previously provisioned CVU transaction context. The CVU account number and any prior deposits are unaffected. This route isn't available for Bre-B.

Path

transactionContextIdstring, (uuid)required

The PXP identifier of the provisioned CVU transaction context, returned by the provision endpoint. Must be a GUID. A non-GUID value fails route matching rather than returning a validation error.

Example:3f6f0d0e-6d2a-4b7e-9d3c-1a2b3c4d5e6f

Bodyapplication/jsonrequired

merchantstring, [ 3 .. 50 ] charactersrequired

Your merchant identifier, as assigned by PXP.

Example:"MERCHANT-1"

sitestring, [ 3 .. 50 ] charactersrequired

Your site identifier, as assigned by PXP.

Example:"SITE-1"

aliasstring^[a-zA-Z0-9.\-]{6,20}$required

The new human-readable alias for the CVU account.

Example:"maria.lopez.updated"

shopperIdstring, [ 3 .. 50 ] characters

Optional cross-check against the shopper on the stored context. When omitted, the stored value is used.

Example:"Shopper_AR_01"

cvustring^[0-9]{22}$

Optional cross-check against the 22-digit CVU on the stored context. When omitted, the stored value is used. Treat as sensitive.

Example:"0000003100010000000001"

documentTypestring

Optional shopper identity document type. Treat as sensitive. Unlike provision, this field is restricted to three types of documents: IdentityDocument, TaxIdNumber, and CivilRegisterId. Passport and ForeignResidentCard are provision-only and are rejected here.

Enum:"IdentityDocument""TaxIdNumber""CivilRegisterId"

Example:"TaxIdNumber"

documentNumberstring, [ 3 .. 50 ] characters

Optional shopper identity document number. Treat as sensitive.

Example:"20123456789"

curl -i -X PUT \
  https://api-services.pxp.io/api/v1/transaction-contexts/3f6f0d0e-6d2a-4b7e-9d3c-1a2b3c4d5e6f/alias \
  -H 'Content-Type: application/json' \
  -d '{
    "merchant": "MERCHANT-1",
    "site": "SITE-1",
    "alias": "maria.lopez.updated"
  }'

Responses

CVU alias update result. Optional fields are omitted when they have no value, rather than returned as null.

Bodyapplication/json

transactionContextIdstring, (uuid)required

The PXP identifier for the provisioned context.

Example:"3f6f0d0e-6d2a-4b7e-9d3c-1a2b3c4d5e6f"

statusstringrequired

The merchant outcome of the alias update.

Possible values:

Success: The alias was updated.
Error: The operation failed. See errorCode and errorMessage.

Enum:"Success""Error"

Example:"Success"

merchantstring

Your merchant identifier, as assigned by PXP.

Example:"MERCHANT-1"

sitestring

Your site identifier, as assigned by PXP.

Example:"SITE-1"

shopperIdstring

Your unique identifier for the shopper on this context.

Example:"Shopper_AR_01"

cvustring

The 22-digit CVU account number. Treat as sensitive.

Example:"0000003100010000000001"

oldAliasstring

The alias held before this update.

Example:"maria.lopez.cvu"

newAliasstring

The alias held after this update. On a failed update, this equals oldAlias.

Example:"maria.lopez.updated"

creationDatestring, (date-time)

The creation time of the owning transaction context, in ISO 8601 or RFC 3339 date-time format. Not the time of the alias change.

Example:"2026-08-28T12:00:00Z"

errorCodestring

PXP-mapped error code. Present only when status is Error.

errorMessagestring

PXP-authored error message. Present only when status is Error.

Response

{
  "transactionContextId": "3f6f0d0e-6d2a-4b7e-9d3c-1a2b3c4d5e6f",
  "status": "Success",
  "merchant": "MERCHANT-1",
  "site": "SITE-1",
  "shopperId": "Shopper_AR_01",
  "cvu": "0000003100010000000001",
  "oldAlias": "maria.lopez.cvu",
  "newAlias": "maria.lopez.updated",
  "creationDate": "2026-08-28T12:00:00Z"
}