Delete a cloud API key of a merchant

DELETE 
https://portal.handpoint.com/partner/cloudpos/partner/:partnerId/merchant/:merchantId/keys/:keyName

Deletes a cloud API key from a 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.

keyName stringrequired

Name of the API key to be deleted.

Responses

200

OK

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"
}

404

Not Found

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"
}

Authorization: http

name: BearerAuthtype: httpscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X DELETE 'https://portal.handpoint.com/partner/cloudpos/partner/:partnerId/merchant/:merchantId/keys/:keyName' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://portal.handpoint.com

Auth

Bearer Token

Parameters

partnerId — pathrequired

merchantId — pathrequired

keyName — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!