Create Network Token Cryptogram

POST 
/network-tokens/:networkTokenId/cryptogram

Allows the issuing of a cryptogram for a previously created network token.

tip

The Network token ID is generated through Create Network Token.

Request

Path Parameters

networkTokenId uuidrequired

Possible values: <= 36 characters

Network token identifier generated through Create Network Token.

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

application/json

Body

required

partnerReference string

Possible values: <= 40 characters, Value must match regular expression ^[a-zA-Z0-9\-_\.:]+$

Request identifier provided by the merchant

targetMerchantAccountReference string

Possible values: <= 127 characters

Indicates the account number or billing reference to be used.

Responses

201

Network token cryptogram successfully created

application/json

Schema

Schema

id uuidrequired

Possible values: <= 36 characters

NTC identifier of the network token. The Network Token Cryptogram is a unique encrypted value generated for each network token transaction, used to authenticate and secure the transaction.

tokenReferenceIdentifier uuidrequired

Possible values: <= 36 characters

Token reference identifier, coming from JPM.

networkToken

object

required

cryptogram stringrequired

Possible values: <= 100 characters

The cryptogram generated by JPM NTS (Network Token Service).

extIdentifier uuidrequired

Possible values: <= 36 characters

External identifier of the token, coming from JPM.

tokenExpiryMonth stringrequired

Possible values: >= 2 characters and <= 2 characters

Expiry month of the network token

tokenExpiryYear stringrequired

Possible values: >= 2 characters and <= 4 characters

Expiry year of the network token. YY or YYYY format

tokenNumber stringrequired

Possible values: <= 19 characters

This is the Network Token PAN. It is stored encrypted in the database and when it must be displayed, then it is decrypted

Example (from schema)

{
  "id": "1401de0f-da94-413d-bfcd-8c57a989911c",
  "tokenReferenceIdentifier": "dc7042bb-db6b-4d56-83fc-9d5df65ef80a",
  "networkToken": {
    "tokenExpiryMonth": 8,
    "tokenExpiryYear": 26,
    "tokenNumber": 123456789
  }
}

Example

{
  "id": "1401de0f...a989911c",
  "tokenReferenceIdentifier": "dc7042bb-d...d5df65ef80a",
  "networkToken": {
    "tokenNumber": "4125071111112119",
    "tokenExpiryMonth": "08",
    "tokenExpiryYear": "26",
    "cryptogram": "ACLVj...pAAADFA==",
    "extIdentifier": "e308f658-e...-310cc568ba7c"
  }
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}

Loading...