v1

latestOpenAPI 3.0.12026-07-2421268219.4 KB

/v1/aliases

Patch alias

Update existing aliases and provision Network Tokens.

patch/v1/aliases/{alias}

Path parameters

aliasstring required

Request body

removePlainboolean

Remove the pan from storage.

expiryMonthstring

The expiry month of the card.

expiryYearstring

The expiry year of card.

createNetworkTokenboolean

Create a Network Token.

Response

Successfully patched alias

aliasstring

The requested alias.

fingerprintstring

An unique identifier of the card number. Useful to identify multiple customers' or the same customer's transactions where the same card was used.

type'CARD' | 'CERTIFICATE' | 'PFC' | 'REK' | 'IBAN' | 'TWI' | 'KLN' | 'INT' | 'PAP' | 'ESY' | 'MFX' | 'MPX' | 'SWP' | 'MDP' | 'ALP' | 'PLU' | 'PFP'

maskedstring

The nonsensitive masked representation of the value behind the alias (e.g. 490000xxxxxx0003 for aliases of type CARD)

dateCreatedstring date-time

Creation date

validUntilstring date-time

Valid until

Example response

{
  "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt",
  "fingerprint": "F-coGuJQ55tUk8CnKGI9PX1T",
  "card": {
    "networkToken": {
      "paymentAccountReference": "5001a9f027e5629d11e3949a0800a"
    },
    "altId": {
      "paymentAccountReference": "5001a9f027e5629d11e3949a0800a"
    }
  }
}