Skip to main content
The API uses the OAuth 2.0 client credentials grant. You exchange your client_id and client_secret for an access token, and send that token on every request.
1

Get your credential

A merchant finds its client_id and client_secret in the Quidkey Console. A partner gets them from Quidkey.
The client_secret is a secret. Keep it on your server, never in a browser or a mobile app, and never in a URL.
2

Get an access token

Call POST /oauth2/token with grant_type=client_credentials. Send a form-encoded body, as OAuth 2.0 defines, or JSON.
The response follows OAuth 2.0, so it isn’t a resource document:
Response
There’s no refresh token. When the token expires, after expires_in seconds, exchange your credential again. A failure answers OAuth’s own errors: 401 invalid_client when the credential isn’t accepted, and 400 invalid_request when the request is malformed.
3

Read your API key

Call GET /api-keys/current with the token. It reads the credential that made the request, and its owner is the account that holds it.
Response
The id is the client_id you sent. For a merchant, owner links to the merchant, and ?include=owner adds it to entities. For a partner, owner carries _type: "partner" and the partner’s id, with no _link, because the API doesn’t publish partners. Use that id in partner routes such as GET /partners/{id}/merchants.

What’s Next

The standards

How every response, link, error and retry works

Take a payment with hosted checkout

Create a payment transaction and send the customer to pay

Onboard a merchant

For partners: from a new merchant to going live

Webhooks

Receive and verify events