Get the Merchant's identifier to be used with Paze

GET 
/entities/{entity-id}/client-info

Get the Merchant's identifier to be used with Paze

Request

Path Parameters

entity-id Entity IDrequired

Possible values: non-empty and <= 36 characters

NCP Entity ID

Responses

200

OK

application/json

Schema

Schema

client

object

id Paze ID (string)required

Possible values: <= 100 characters

name Paze Merchant Name (string)required

Possible values: <= 120 characters

profileId Paze Profile ID (string)

Possible values: <= 50 characters

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

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

code stringrequired

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: Internal Processing Error

Example (from schema)

{
  "client": {
    "id": "string",
    "name": "string",
    "profileId": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

client

object

id Paze ID (string)required

Possible values: <= 100 characters

name Paze Merchant Name (string)required

Possible values: <= 120 characters

profileId Paze Profile ID (string)

Possible values: <= 50 characters

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

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

code stringrequired

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: Internal Processing Error

Example (from schema)

{
  "client": {
    "id": "string",
    "name": "string",
    "profileId": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

client

object

id Paze ID (string)required

Possible values: <= 100 characters

name Paze Merchant Name (string)required

Possible values: <= 120 characters

profileId Paze Profile ID (string)

Possible values: <= 50 characters

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

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

code stringrequired

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: Internal Processing Error

Example (from schema)

{
  "client": {
    "id": "string",
    "name": "string",
    "profileId": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

client

object

id Paze ID (string)required

Possible values: <= 100 characters

name Paze Merchant Name (string)required

Possible values: <= 120 characters

profileId Paze Profile ID (string)

Possible values: <= 50 characters

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

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

code stringrequired

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: Internal Processing Error

Example (from schema)

{
  "client": {
    "id": "string",
    "name": "string",
    "profileId": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

404

Conflict

application/json

Schema

Schema

client

object

id Paze ID (string)required

Possible values: <= 100 characters

name Paze Merchant Name (string)required

Possible values: <= 120 characters

profileId Paze Profile ID (string)

Possible values: <= 50 characters

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

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

code stringrequired

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: Internal Processing Error

Example (from schema)

{
  "client": {
    "id": "string",
    "name": "string",
    "profileId": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

client

object

id Paze ID (string)required

Possible values: <= 100 characters

name Paze Merchant Name (string)required

Possible values: <= 120 characters

profileId Paze Profile ID (string)

Possible values: <= 50 characters

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

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

code stringrequired

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: Internal Processing Error

Example (from schema)

{
  "client": {
    "id": "string",
    "name": "string",
    "profileId": "string"
  },
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Loading...