Skip to main content

Create a cloud API key for a merchant

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

Creates a new cloud API key for a merchant. The API response will contain the API key unmasked.

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.

Body

required

The name for the API key to be created. The name is used as part of the randomisation process generating the API key.

    keyName stringrequired

    Possible values: <= 20 characters

    The API key name.

Responses​

OK

Schema
    key stringrequired

    The API key unmasked value.

    keyName stringrequired

    The API key name.

    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.

Loading...