Provision Network Cryptogram

POST 
/network-tokens/cryptograms

Provision a network cryptogram via Visa or MDES.

Request

application/json

Body

required

processingEntityId uuidrequired
Processing entityId provided by Nuvei.
Example: 80aef199-b89a-4d59-ba0c-f2cd3c25d5cd

paymentOption

object

required

paymentToken

object

paymentTokenId Payment Token ID (string)required

Example: 1eaf1356-a9a2-4a16-a0c1-290ba2265257
transactionType stringrequired

Td.

Possible values: [ECOM, AFT]

Responses

201

OK

application/json

Schema

Schema

paymentOption

object

networkToken

object

paymentTokenId string

tokenNumber password

Possible values: <= 29 characters

expirationYear ExpirationYear (string)

expirationMonth ExpirationMonth (string)

tokenStatus TokenStatus (string)

Possible values: <= 40 characters

tokenUniqueReference TokenUniqueReference (string)

Possible values: <= 64 characters

paymentAccountReference PaymentAccountReference (string)

tokenAssuranceLevel TokenAssuranceLevel (string)

cryptogram string

merchantReference Merchant Reference for Payment Token (string)

Merchant Reference for a business entity (token, subscription, etc.)

Possible values: <= 50 characters

Example: MREF_6f06168d-ff6e-448b-8401-30051eb6b1af

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "paymentOption": {
    "networkToken": {
      "paymentTokenId": "string",
      "tokenNumber": "string",
      "expirationYear": "string",
      "expirationMonth": "string",
      "tokenStatus": "string",
      "tokenUniqueReference": "string",
      "paymentAccountReference": "string",
      "tokenAssuranceLevel": "string",
      "cryptogram": "string",
      "merchantReference": "MREF_6f06168d-ff6e-448b-8401-30051eb6b1af"
    }
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

paymentOption

object

networkToken

object

paymentTokenId string

tokenNumber password

Possible values: <= 29 characters

expirationYear ExpirationYear (string)

expirationMonth ExpirationMonth (string)

tokenStatus TokenStatus (string)

Possible values: <= 40 characters

tokenUniqueReference TokenUniqueReference (string)

Possible values: <= 64 characters

paymentAccountReference PaymentAccountReference (string)

tokenAssuranceLevel TokenAssuranceLevel (string)

cryptogram string

merchantReference Merchant Reference for Payment Token (string)

Merchant Reference for a business entity (token, subscription, etc.)

Possible values: <= 50 characters

Example: MREF_6f06168d-ff6e-448b-8401-30051eb6b1af

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "paymentOption": {
    "networkToken": {
      "paymentTokenId": "string",
      "tokenNumber": "string",
      "expirationYear": "string",
      "expirationMonth": "string",
      "tokenStatus": "string",
      "tokenUniqueReference": "string",
      "paymentAccountReference": "string",
      "tokenAssuranceLevel": "string",
      "cryptogram": "string",
      "merchantReference": "MREF_6f06168d-ff6e-448b-8401-30051eb6b1af"
    }
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

Invalid Value

{
  "result": {
    "status": "error",
    "errors": {
      "code": "5000.1000",
      "reason": "[paymentOption.card.expirationMonth] must match \"^(0[1-9]|1[0-2])$\""
    }
  }
}

Missing Mandatory Field Value

{
  "result": {
    "status": "error",
    "errors": {
      "code": "5000.1000",
      "reason": "[processingEntityId] must not be null"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

paymentOption

object

networkToken

object

paymentTokenId string

tokenNumber password

Possible values: <= 29 characters

expirationYear ExpirationYear (string)

expirationMonth ExpirationMonth (string)

tokenStatus TokenStatus (string)

Possible values: <= 40 characters

tokenUniqueReference TokenUniqueReference (string)

Possible values: <= 64 characters

paymentAccountReference PaymentAccountReference (string)

tokenAssuranceLevel TokenAssuranceLevel (string)

cryptogram string

merchantReference Merchant Reference for Payment Token (string)

Merchant Reference for a business entity (token, subscription, etc.)

Possible values: <= 50 characters

Example: MREF_6f06168d-ff6e-448b-8401-30051eb6b1af

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "paymentOption": {
    "networkToken": {
      "paymentTokenId": "string",
      "tokenNumber": "string",
      "expirationYear": "string",
      "expirationMonth": "string",
      "tokenStatus": "string",
      "tokenUniqueReference": "string",
      "paymentAccountReference": "string",
      "tokenAssuranceLevel": "string",
      "cryptogram": "string",
      "merchantReference": "MREF_6f06168d-ff6e-448b-8401-30051eb6b1af"
    }
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

Authorization Error

{
  "result": {
    "status": "error",
    "errors": {
      "code": "7300.3000",
      "reason": "Authorization error."
    }
  }
}

403

Forbidden

application/json

Schema

Schema

paymentOption

object

networkToken

object

paymentTokenId string

tokenNumber password

Possible values: <= 29 characters

expirationYear ExpirationYear (string)

expirationMonth ExpirationMonth (string)

tokenStatus TokenStatus (string)

Possible values: <= 40 characters

tokenUniqueReference TokenUniqueReference (string)

Possible values: <= 64 characters

paymentAccountReference PaymentAccountReference (string)

tokenAssuranceLevel TokenAssuranceLevel (string)

cryptogram string

merchantReference Merchant Reference for Payment Token (string)

Merchant Reference for a business entity (token, subscription, etc.)

Possible values: <= 50 characters

Example: MREF_6f06168d-ff6e-448b-8401-30051eb6b1af

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "paymentOption": {
    "networkToken": {
      "paymentTokenId": "string",
      "tokenNumber": "string",
      "expirationYear": "string",
      "expirationMonth": "string",
      "tokenStatus": "string",
      "tokenUniqueReference": "string",
      "paymentAccountReference": "string",
      "tokenAssuranceLevel": "string",
      "cryptogram": "string",
      "merchantReference": "MREF_6f06168d-ff6e-448b-8401-30051eb6b1af"
    }
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

Authorization Error

Authorization error

{
  "result": {
    "status": "error",
    "errors": {
      "code": "7300.3000",
      "reason": "Authorization error."
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

paymentOption

object

networkToken

object

paymentTokenId string

tokenNumber password

Possible values: <= 29 characters

expirationYear ExpirationYear (string)

expirationMonth ExpirationMonth (string)

tokenStatus TokenStatus (string)

Possible values: <= 40 characters

tokenUniqueReference TokenUniqueReference (string)

Possible values: <= 64 characters

paymentAccountReference PaymentAccountReference (string)

tokenAssuranceLevel TokenAssuranceLevel (string)

cryptogram string

merchantReference Merchant Reference for Payment Token (string)

Merchant Reference for a business entity (token, subscription, etc.)

Possible values: <= 50 characters

Example: MREF_6f06168d-ff6e-448b-8401-30051eb6b1af

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "paymentOption": {
    "networkToken": {
      "paymentTokenId": "string",
      "tokenNumber": "string",
      "expirationYear": "string",
      "expirationMonth": "string",
      "tokenStatus": "string",
      "tokenUniqueReference": "string",
      "paymentAccountReference": "string",
      "tokenAssuranceLevel": "string",
      "cryptogram": "string",
      "merchantReference": "MREF_6f06168d-ff6e-448b-8401-30051eb6b1af"
    }
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

Internal Processing Error

Internal processing error

{
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error."
    }
  }
}

Loading...