v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

Instruments

Generate cryptogram for a Network Token

Generate cryptogram for a Network Token of a given instrument.

post/payment/instruments/{instrumentId}/generateCryptogram

Path parameters

instrumentIdstring uuid required

Identifier of the resource in Payrails.

Headers

x-idempotency-keystring uuid required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Request body

providerConfigIdstring uuid

Optional. The ID of the network token provider config to use for cryptogram generation. When provided, the request validates the config with the same rules as network token provision. When omitted, the workflow resolves the provider config from the instrument token path or, for legacy tokens without metadata, falls back to the active provider config only when it is unambiguous.

Example request

{
  "amount": {
    "value": "12.50",
    "currency": "EUR"
  },
  "riskData": {
    "ip4address": "101.101.101.10"
  },
  "providerConfigId": "69e0aac4-2939-427e-aa37-d79e4989219c"
}

Response

Success.

successboolean required

Whether or not a cryptogram was successfully generated.