Getting access
What has to be true before a live key works.
1. A partner account
Partner access is granted to an approved merchant account. If the partner pages shows you "No partner access", that is what is missing, and it is granted by us rather than self-served. Talk to your GetElectric contact.
2. KYB approval, for live only
| Test key | Live key | |
|---|---|---|
| Account enabled | required | required |
| KYB approved | not checked | required |
So you can build the whole integration before approval comes through, which is the point of the ordering here. Start in the sandbox on day one.
Get account reports kyb_status and enabled.
A live key on an account that is not approved is refused with 403 and "This
token cannot use the partner API."
3. An API key
Issue keys on the API keys page, one mode at a time. The secret appears once, when you create it, and is never retrievable. We store a hash.
Issue separate keys for separate deployments rather than sharing one. Revoking a leaked key then costs you one deployment instead of all of them.
4. A funded balance, for live
Live orders spend your partner balance. An order that the balance will not cover is refused. Test mode uses play money and needs no funding.
5. A webhook endpoint
Not strictly required to place orders, and you want it before you place real
ones. Without it you are polling for every outcome. Set a URL and a signing
secret per mode on the Webhooks page, and get a test
callback returning 200 before you go live. See
Webhooks.
6. An address allowlist, recommended for live
Your account can carry a list of addresses and CIDR ranges your live key may call from. Empty means anywhere, which is a reasonable place to start and a poor place to stay: a leaked key is then usable from anywhere on the internet.
calling_from on Get account reports the
address we saw your request arrive from, so you do not have to guess what to
add. Test keys ignore the allowlist, so adding one will not break your local
development.
What we need from you
Nothing technical. No IP addresses up front, no callback URL registration by email, no certificate exchange. You set the webhook and the allowlist yourself in your dashboard, and you issue your own keys.
A reasonable order of work
- Test key, and
GET /reseller/mereturningmode: "test". - Quickstart: verify, order, retry, poll.
- Webhook endpoint, with a signature check, proved by the dashboard's test callback.
- The failure paths:
22222222222and33333333333, and an empty sandbox balance. - Going live.
Steps 1 to 4 need nothing from us beyond the account itself.