Skip to main content
To interact with the Cashii API, your application needs to authenticate using an API key. This key acts as a secure credential, identifying your application and granting it specific permissions.

Generating your API key

Before generating an API key, ensure you have set up your Cashii accounts:
If you haven’t already, you must have a verified Cashii personal account. Follow the steps outlined in the account creation video to set up your account.
API keys are associated with commercial accounts. After creating a personal account, request a commercial account. Refer to the commercial account setup guide for detailed instructions.
Once your commercial account is active, follow these steps to generate an API key:
  1. Log in to the Cashii app and switch to your commercial account.
  2. Open the navigation menu.
  3. Navigate to Manage Users.
  4. Select Manage API Keys.
  5. Click Add API Key.
  6. Enter a descriptive reference name for the API key (e.g., “My Web App Integration”).
  7. Important: Copy the generated API key immediately and store it securely. You will not be able to view it again after this step.
  8. Enable the necessary permissions for this key. For payment integrations, ensure Manage Remote Payments is checked.
  9. Click Save.
Keep your API keys confidential. Do not share them publicly or embed them directly in client-side code.

Using Your API Key

Include your API key in the Authorization header of your API requests, using the Bearer authentication scheme:
Authorization: Bearer YOUR_API_KEY
Replace YOUR_API_KEY with the actual key you generated.