What to ask for
API credentials
A Client ID and an API key, for the environment you are starting in.
Dashboard access
A login for the people who will watch payments, register webhook endpoints and answer compliance requests.
The credentials, and what each is for
You exchange the Client ID and the API key for a token, and you send the token on every other call. You do not need the legacy key. Integrations that already send it keep working.
The API key and the legacy key were both renamed, and the values did not change. Once you have your first API key, you can create more yourself. API keys explains how.
Your webhook endpoints
Endpoints are self-serve. You register them in the Developers section of the dashboard, and you can register more than one. Each event type goes to exactly one URL, so how you split them across endpoints is your choice. Webhooks overview has the rules that govern them. There are no/v1 endpoints for any of this. The API cannot read or change an endpoint.
Register at least one before you start, because several things in the flow only ever announce themselves by webhook. An integration that waits until the end to think about webhooks will get to a payment stuck in an in-between state with nothing telling it why.
What Kira will ask you for
To provision the above, expect to supply:- Who needs dashboard access, and which role each of them starts with.
- Which environment you are starting in. Everyone starts in sandbox.
When you have it
Check the credentials work before writing anything else. That is one call, and it is the next page.Authentication
Exchange your credentials for a token and make an authenticated call.