Authentication

Authenticate with the Snippe API using API keys

All API requests require authentication using an API key in the Authorization header.

Authorization: Bearer snp_your_api_key_here

Getting Your API Key

  1. Log in to your Snippe Dashboard
  2. Go to SettingsAPI Keys
  3. Click Create API Key
  4. Copy and store your key securely

Your API key is only shown once. Store it securely immediately.

Example Request

curl -X GET https://api.snippe.sh/v1/payments \
  -H "Authorization: Bearer snp_your_api_key_here"

Scopes

ScopeDescription
collection:readView payments and balance
collection:createCreate payment intents
disbursement:readView payouts
disbursement:createCreate payouts

Error Responses

Invalid or Missing API Key (401)

{
  "status": 401,
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key"
  }
}

Insufficient Scope (403)

{
  "status": 403,
  "error": {
    "code": "insufficient_scope",
    "message": "API key does not have required scope: disbursement:create"
  }
}

On this page