Retrieve the cloud API keys of a merchant

GET 
/partner/cloudpos/partner/:partnerId/merchant/:merchantId/keys

Gets the list of cloud API keys previously created for the merchant.

Request

Path Parameters

partnerId PartnerIDrequired

Possible values: non-empty and <= 50 characters

Your partner ID.

merchantId MerchantIDrequired

Possible values: non-empty and <= 20 characters

ID of the merchant.

Responses

200

OK

application/json

Schema

Schema

keyList object[]required
List of API keys created for the merchant.
Array [
key stringrequired
The API key masked value.
keyName stringrequired
The API key name.
maskedKey stringrequired
The API key masked value.
merchantIdAlpha MerchantIDrequired
Possible values: non-empty and <= 20 characters
It is a unique Handpoint ID for the merchant, it must be unique across ALL TMS merchants. Handpoint will provide a range of IDs that can be used for this purpose.
]

Example (from schema)

{
  "keyList": [
    {
      "key": "string",
      "keyName": "string",
      "maskedKey": "string",
      "merchantIdAlpha": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

code string

Error code.

reason string

Reason of the error.

messageGuid string

Message guid of the error.

Example (from schema)

{
  "code": "string",
  "reason": "string",
  "messageGuid": "string"
}

401

Unauthorized

application/json

Schema

Schema

code string

Error code.

reason string

Reason of the error.

messageGuid string

Message guid of the error.

Example (from schema)

{
  "code": "string",
  "reason": "string",
  "messageGuid": "string"
}

403

Forbidden

application/json

Schema

Schema

code string

Error code.

reason string

Reason of the error.

messageGuid string

Message guid of the error.

Example (from schema)

{
  "code": "string",
  "reason": "string",
  "messageGuid": "string"
}

500

Internal Server Error

application/json

Schema

Schema

code string

Error code.

reason string

Reason of the error.

messageGuid string

Message guid of the error.

Example (from schema)

{
  "code": "string",
  "reason": "string",
  "messageGuid": "string"
}

Loading...