Registers a PKCS#12 Object

POST 
/entities/{entity-id}/certificates

Registers a PKCS#12 Object

Request

Path Parameters

entity-id uuidrequired

NCP Processing Entity ID

application/json

Body

required

name stringrequired
Possible values: <= 50 characters
Example: Nuvei Apple Pay Mass-Enablement Certificate
keyData byterequired
type CertificateTypeName (string)required
Possible values: [ROOT, IDENTITY, PAYMENT]
Default value: PAYMENT
integration IntegrationTypeName (string)required
Possible values: [API]
Default value: API
status CertificateStatusName (string)required

Possible values: [ACTIVE]

expirationDate date-time
Example: 2025-12-31T00:00:00Z
providerMerchantId string
Possible values: <= 255 characters
Example: merchant.com.nuvei.reference
providerMerchantDisplayName string
Possible values: <= 50 characters
Example: Apple Pay Reference Implementation
password stringrequired
Possible values: <= 100 characters
Default value:
Example: *****

Responses

201

Certificate Created

application/json

Schema

Schema

id CertificateId (string)

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Internal reference for troubleshooting

Possible values: <= 400 characters

Example: 110.1290

Example (from schema)

{
  "id": "string",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error",
      "reference": "110.1290"
    }
  }
}

400

Bad request

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Internal reference for troubleshooting

Possible values: <= 400 characters

Example: 110.1290

Example (from schema)

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

401

Unauthorized

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Internal reference for troubleshooting

Possible values: <= 400 characters

Example: 110.1290

Example (from schema)

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

403

Forbidden

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Internal reference for troubleshooting

Possible values: <= 400 characters

Example: 110.1290

Example (from schema)

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

404

Not Found

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Internal reference for troubleshooting

Possible values: <= 400 characters

Example: 110.1290

Example (from schema)

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

500

Internal Server Error

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: <= 50 characters, [error, success]

errors

object

code stringrequired

Possible values: <= 11 characters

Example: 7000.1000

reason string

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Internal reference for troubleshooting

Possible values: <= 400 characters

Example: 110.1290

Example (from schema)

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

Loading...