Returns a PKCS#12 Objects based on the provided search criteria

GET 
/entities/{entity-id}/certificates

Returns a PKCS#12 Objects based on the provided search criteria

Request

Path Parameters

entity-id uuidrequired

NCP Processing Entity ID

Query Parameters

type CertificateTypeNamerequired
Possible values: [ROOT, IDENTITY, PAYMENT]
Certificate type
Default value: PAYMENT
Example: IDENTITY
integration IntegrationTypeName
Possible values: [API]
Integration type
Default value: API
Example: API

Responses

200

Certificate Result

application/json

Schema

Schema

certificate

object

id CertificateId (string)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, EXPIRED]

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

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)

{
  "certificate": {
    "id": "string",
    "name": "Nuvei Apple Pay Mass-Enablement Certificate",
    "keyData": "string",
    "type": "PAYMENT",
    "integration": "API",
    "status": "ACTIVE",
    "expirationDate": "2025-12-31T00:00:00Z",
    "providerMerchantId": "merchant.com.nuvei.reference",
    "providerMerchantDisplayName": "Apple Pay Reference Implementation"
  },
  "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...