Connect iK Pay API to a custom website or platform

Use iK Pay API when you are building a custom website, app or platform integration and a standard ecommerce plugin is not the right fit. Generate the credentials in the iK Dashboard, store them securely and give your developer the iK Pay API developer documentation.

Prepare your API setup

• Have an active iKhokha profile.

• Know which website, app or platform will use the integration.

• Have a secure password manager or secret store ready for the credentials.

• Make sure the person generating the key understands that it may provide access to payment functionality.

Generate API credentials

1. Sign in to the iK Dashboard.

2. Open Integrations.

3. Choose the option to create an API key or credential.

4. Give the key a name that identifies the website or system.

5. Create the key and copy the key and secret when they are shown.

Protect the credentials

Store the key and secret securely. Do not place a secret in public JavaScript, a public repository, a screenshot, a support message or a browser-visible page. Give credentials only to the developer or system that needs them.

Build and test

Use the iK Pay API developer documentation for authentication, endpoints, request fields, responses, webhooks and testing. These steps cover how to obtain and protect credentials, while the developer documentation is the source for the technical specification.

Test the complete payment and return process before going live. Confirm that your system records the payment result and does not mark an order paid based only on a customer returning to your website.

If a credential is exposed

Stop using the exposed secret and contact iKhokha Support on 087 222 7000 or support@ikhokha.com for the replacement steps. Do not include the credential when you ask for help.

If an API payment fails after the integration is live, see Why an online payment failed. To refund a payment, see Refund an online payment.