PCpci-proxy
/v1/aliases

Patch alias

Changed on

Update existing aliases and provision Network Tokens.

patch/v1/aliases/{alias}

Request

  • Base URL
    https://api.sandbox.datatrans.com
  • URL
    https://api.sandbox.datatrans.com/v1/aliases/{alias}
  • Auth
    HTTP basic

Path parameters

aliasstring required

Request body

removePlainboolean

Remove the pan from storage.

expiryMonthstring

The expiry month of the card behind the alias.

expiryYearstring

The expiry year of the card behind the alias.

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' | 'DMO'
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"
    }
  }
}

Changes

  • 78b27ccc5443Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      added the new C2P enum value to the / response property for the response status

    • warning

      added the new CONCURRENT_LIMIT_REACHED enum value to the / response property for the response status

    • warning

      added the new DMO enum value to the response property for the response status

    • warning

      added the new NOT_FOUND enum value to the / response property for the response status

    • info

      added the new optional request property /

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status