For the complete documentation index, see llms.txt. This page is also available as Markdown.

FAQ

Does the key authorize transactions?

No. It credits the call to your company and applies your fee. Moving funds still needs the user's session signature or EIP-712 signature. See Authentication.

Can I use my key with the SDK, WaaS or MCP?

No. API keys are read only on the Hinkal API routes listed in Integrating Your Key. The WaaS routes (/waas/…) run on the same host, api.hinkal.io, but ignore the key, and the SDKs and MCP never send it. Traffic through them isn't credited to you.

What's the difference between my API keys and the Partner key?

API keys go in the x-api-key header of Hinkal API calls. They credit the call to you and apply your fee and your Hinkal fee. The Partner key is entered by a person in Hinkal Pay and only gives your Hinkal fee there. It earns no commission. Sending the Partner key in x-api-key returns 401. See Partner key.

Can I change my Hinkal fee?

Not from the portal. Hinkal sets it, by default 10 bps. Contact Hinkal if you have a custom agreement.

Someone else has my Partner key. What do I do?

You can't revoke or replace it from the portal. Contact Hinkal to issue a new one. The old key stops working right away. Anyone using it in Pay goes back to the standard fee once they reload Pay.

Which key do I use in a mobile app?

Neither, directly. Native apps send no Origin header, so a publishable key returns 403, and a secret key must not ship inside an app. Send the app's calls through a proxy on your backend that adds the secret key. See Integrating Your Key.

Why does my publishable key return 403?

The request's origin isn't an exact match for one on the key's list, the list is empty, or the call comes from a server or a native app. www., other subdomains and other ports count as different origins. See Allowed origins.

Why am I not earning anything?

Check that your fee was above 0 when the transactions ran (fee changes don't apply to past transactions), that the calls carried your key in x-api-key, and that they weren't deposits or recoveries. See What earns.

Why don't deposits to my receive address show up?

/receive-address doesn't read the key, so deposits that arrive at a receive address aren't credited to you.

Is there a test or sandbox key?

No. Every key is live. Use a separate key per environment, so Analytics keeps them apart.

Can I change my company name?

No. It's set once at sign-up.

Who can withdraw earnings?

Only the Owner, from the Earnings page. See Request a payout.

How are payouts sent?

The Hinkal team reviews each request and sends it manually, in the same token and on the same chain the commission was earned. Track the status in Payout history.

How quickly do changes apply?

Fee changes, turning a key on or off, revoking and origin edits reach the API within about 60 seconds. See When changes reach the API.

When does a transaction show up in Hinkal Partner?

After it confirms on-chain. On Solana, that means finalized. Private sends show up per recipient as each payout completes. See Transactions.

Last updated