Prepare TikiPay credentials
Buy/activate the plan you need, create a Brand in the TikiPay dashboard, then copy the Brand API Key. Your website checkout uses the Brand API Key. A Device Key is for the TikiPay mobile/SMS connector and should not replace the Brand API Key in website modules.
Set the API Base URL
Enter the payment/API host where your TikiPay payment script runs, for example https://pay.your-domain.com. The modules do not hard-code the current testing domain, so the same package can move to a future production domain.
Install the package
Extract the downloaded ZIP and follow its README.md. Upload/copy the included files into the platform paths described there. Platform forks may change hooks or paths, so use a staging copy first.
Run the recommended payment flow
- Create the local order/invoice first.
- Call TikiPay Create from your backend.
- Save the returned
invoice_id. - Redirect the customer to
payment_url. - After return/webhook, call Verify from your backend.
- Fulfill only when status is
COMPLETED. - Make fulfillment idempotent so a repeated callback cannot deliver twice.
Existing integration migration
TikiPay accepts multiple compatible request shapes. If your current integration already matches a supported contract, point its configurable API Base URL to the TikiPay payment host once and paste the TikiPay Brand API Key. You do not need to rewrite its field mapping or response parser when the contract already matches.
Test before going live
Test a successful payment, pending payment, cancel flow, repeated webhook, wrong amount, invalid API key, and a duplicate callback. Keep API keys in environment variables or encrypted platform settings.