Access tokens

Access Tokens are used to authenticate API requests and manage integrations with the system. Tokens must be handled securely as they grant access to specific functionalities within the platform. For detailed integration documentation, refer to: Kwik API Specification.

Generating an Access Token

Follow these steps to create an Access Token:

  1. Navigate to the Developers > Access Tokens section in the menu.

  1. Click on the "Create" button at the top right corner of the page.

  2. Populate the required fields:

  • Name: Enter a descriptive name for the token. This helps identify who the token was created for.

  • Sections Choose the sections the token should have access to:

    • One-time: Allows access/handling of One-time Payments.

    • Recurring: Allows access/handling of Recurring Payments.

    • Transactions: Provides access to all transactions based on both One-time and Recurring payments.

    Note: You may select more than one option in this field.

  • Permissions: Select the level of access:

    • Read-only: Allows viewing of data without making changes.

    • Read-Write: Grants permission to view and add/edit data.

  • Status: Choose the token's operational status:

    • Disabled: The token is inactive and cannot be used.

    • Live: The token is active and can authenticate API requests.

    • Testing: The token is in a test environment and cannot be used for live transactions.

  1. Click on "Create" to generate the token.

  2. Copy the key and secret immediately.

Important to note: The secret will only be accessible at this point for security reasons. Ensure you store it securely.

Using the Access Token

After generating the token, the key and secret may be used to authenticate API requests.

Security Note:

  • Never share your Access Tokens publicly.

  • If a token is compromised, immediately disable and regenerate it.

For more information on integrating with the API, refer to Kwik API Specification.

Last updated