Help Section
Developers

Access Tokens

 

Create and manage API credentials for integrating with the Kwik platform.

Access Tokens allow developers to securely access the Kwik API and integrate external systems with the platform.

The generated credentials can be used for:

  • Payment processing
  • Customer management
  • Mandate management
  • Transaction reporting
  • Payouts
  • Checkout integrations

API Documentation: https://docs.kwik.co.za/v2/overview

Checkout Form Documentation: https://docs.kwik.co.za/v2/money-in/checkout-form

Overview

The Access Tokens screen displays all API credentials configured for your account.

The table includes:

ColumnDescription
CreatedDate the token was created.
NameFriendly name used to identify the integration.
KeyPartial API key for identification purposes.
StatusCurrent token status.
PermissionsAccess level assigned to the token.
SectionsPlatform areas the token can access.

Creating an Access Token

Select Create to generate a new set of API credentials.

The following screen will be displayed:

Token Fields

FieldDescription
NameFriendly name used to identify the integration.
SectionsAreas of the platform the token may access.
PermissionsRead-only or read-write access.
StatusWhether the token is active or disabled.

Sections

Sections determine which API resources can be accessed.

Examples include:

  • Customers
  • Customer Bank Accounts
  • Customer Cards
  • Customer Mandates
  • Payments
  • Transactions
  • Recipients
  • Payouts
  • Checkout Page
  • Orders

Only the selected sections will be accessible through the API.

Permissions

Permissions determine what actions the token may perform.

PermissionDescription
Read-OnlyCan retrieve data but cannot create, update or delete records.
Read-WriteFull access to create, update and retrieve records within the selected sections.

Status

Tokens can be activated or disabled at any time.

StatusDescription
LiveToken is active and can be used.
DisabledToken cannot be used until re-enabled.

Generated Credentials

Once the token has been created, the credentials will be displayed once.

The following credentials are generated:

CredentialPurpose
API_KEYUsed to authenticate server-to-server API requests.
API_SECRETUsed together with the API key to generate API signatures and authenticate requests.
PUBLIC_KEYUsed by the Checkout Form integration.

API Key and API Secret

The API_KEY and API_SECRET are used when making JSON API requests to the Kwik API.

Documentation:

https://docs.kwik.co.za/v2/overview

Important: These credentials are only displayed once. Store them securely before continuing.

Public Key

The PUBLIC_KEY is used when integrating the hosted checkout form.

Documentation:

https://docs.kwik.co.za/v2/money-in/checkout-form

The public key is safe to expose in browser-based integrations and is used to initialise the checkout experience.

Security Recommendations

  • Store API credentials securely.
  • Never expose API secrets in frontend applications.
  • Use Read-Only permissions where possible.
  • Create separate tokens for different integrations.
  • Disable unused tokens immediately.
  • Restrict tokens to only the sections required by the integration.

API Documentation:

https://docs.kwik.co.za/v2/overview

Checkout Form:

https://docs.kwik.co.za/v2/money-in/checkout-form

Manage Webhooks:

Webhooks

Manage Integrations:

Integrations