Skip to main content
The Quidkey API lets a partner onboard its merchants and create payment transactions for them, and lets a merchant create payment transactions, refund them and follow its payouts. Every request goes to one base URL:
There’s no separate sandbox host. A test payment transaction goes through the same API as a live one, with is_test: true, and moves no real money. See Test an integration.
Before you start: a merchant finds its client_id and client_secret in the Quidkey Console. A partner gets them from Quidkey. Getting started exchanges them for a token and makes a first call.

Who Calls the API

A credential belongs to one account: a partner or a merchant.

How the API Is Shaped

Every endpoint follows the same standards:
  • One document shape. A successful response holds result, entities and not_included.
  • Links. A relationship is a link object, and include hydrates it into entities.
  • Money as an object. { "value": 4500, "currency": "GBP" }, in the currency’s minor units.
  • Errors. Every error has a stable code and says whether it’s retryable.
  • Idempotency. Creates take an Idempotency-Key, so a lost response is recovered without paying twice.
IDs in these guides are shortened for readability, such as m_1 and tx_1. Real IDs are opaque strings: store them as they are, and don’t parse them.

Journeys

Each journey is a complete path through the API, step by step. Steps marked Console or Quidkey are done by a person or by Quidkey, not by an API call.

Set up a partner account

Get a token and find your merchants

Onboard a merchant

From a new merchant to its first live payment transaction

Take a payment with hosted checkout

Create a payment transaction and send the customer to pay

Refund a payment transaction

Prepare, execute and follow a refund

API Reference

The reference lists every endpoint with its permission, the representations it returns, what it can include, how it paginates, its error codes and whether it needs an Idempotency-Key. It’s generated from the API’s OpenAPI document, which you can download and use with your own tooling.