Credentials and access

Create a Payment API key

Issues a new Payment API key. Despite being a create, the verb is PUT and the operation is selected by a required operation=apiKey.create query parameter — omit it and the call is rejected.

The key is created in the environment you called, taken from the host, not from anything you send. Requires the API-key permission on your user's role.

Rotating a key is create-then-delete: issue the new key, move your integrations onto it, then delete the old one. There is no in-place rotation, so nothing breaks while both keys are live.

put/v2/merchants/api-keys

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/merchants/api-keys
  • Auth: API key in header Authorization

Query parameters

operation'apiKey.create' required

Must be apiKey.create.

Request body

keyNamestring required

Your label for the key.

Response

The created key.

messagestring

Example response

{
  "body": {
    "merchantId": "MID-123-456"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.