Creating API Key

Most Cryptix API requests must be authenticated using an API key. You can create an API key on the settings page after creating a Cryptix account.

How to create

1. Log in to Cryptix.
2. Open Settings > API Keys.
3. Choose Token scopes for this key.
4. Click Create New Key.

Authenticated API requests must be made with the Authorization: Bearer <token> header. Your secret API key should be passed as the value for <token>.

If authentication fails, a JSON object with an error message is returned with HTTP status 401.

Example authenticated request:

curl https://api.cryptix.io/v2.0/checkouts \
-H "Authorization: Bearer <Your API Key>"

Token Scopes

The default scope currently includes the following methods:

[
    "charges.get",
    "charges.post",
    "deposits.get",
    "deposits.post",
    "deposits.id.get",
    "deposits.payments.get",
    "checkouts.get",
    "checkouts.post",
    "checkouts.id.put",
    "checkouts.id.delete",
    "invoices.get",
    "invoices.post",
    "invoices.id.void.put",
    "invoices.id.resolve.put",
    "mass-payouts.get",
    "mass-payouts.post",
    "mass-payouts.id.payouts.get", 
    "mass-payouts.id.delete",
    "mass-payouts.id.send.put",
    "converts.get",
    "converts.token.get",
    "converts.post",
    "converts.id.get",
    "balances.get"
]

Scope Restrictions

If you attempt to call an API method using a token that does not include the required method in its scope, the server will respond with a 403 Forbidden error.

You will receive the same 403 error if you try to access methods that are not part of the default scope using a token that lacks the appropriate permissions.

---