Create an Api Key

​

Create a new API key for a user

Body
required
application/json

Request to create an API key

  • name
    Type: string
    required

    Name of the API key to help identify it

  • role
    Type: stringenum
    required
    values
    • ADMIN

      Full administrative access to all resources

    • MEMBER

      Read-only access to all resources

    • DEVELOPER

      Access to payment operations, typically assigned to API keys used for payment integrations

  • livemode
    Type: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Responses
  • application/json
  • application/json
Request Example for post/v1/credentials/api-keys
curl https://api.paypercut.io/v1/credentials/api-keys \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Production API Key",
  "role": "DEVELOPER"
}'

{
  "id": "21210021c2855007efa2d657018",
  "secret": "sk_test_1234567890abcdef"
}

API key created successfully