Skip to main content
A merchant’s own credential creates payment transactions, refunds them and runs the merchant’s webhook endpoints. It does the merchant’s onboarding too, apart from starting identity checks and requesting capabilities, which its partner does.

1. Find Your Credential

Someone at the merchant signs in to the Quidkey Console and copies the client_id and client_secret. Revoking or rotating the secret happens there too, not through the API. A token issued before the secret was revoked or rotated stops working. Person.

2. Get a Token and Read Your API Key

Exchange the credential for a token as Getting started shows, then:
owner links to your merchant, and ?include=owner adds it to entities. Its id is your merchant ID.

3. List Your Transactions

The list holds live payment transactions, refunds and reversals, newest first, in the summary view. It takes filters such as type, status, order_id and created_at ranges.

4. Read a Payment Transaction After an Event

5. List Your Webhook Endpoints

A merchant can have several endpoints, each with a name.

6. Create an Endpoint

The answer holds signing_secret once: store it now. If it has none, as a replay doesn’t, :rotateSecret issues one. name is unique to the merchant and can’t change. is_signed defaults to true.

7. Change an Endpoint

A PATCH takes url, status, is_signed and is_default. A merchant with more than one active endpoint sets a default, or names endpoints on each payment transaction in webhook_endpoints: otherwise an event has nowhere to go. is_default: true needs an active endpoint, and clears any other default. Turning is_signed on for an endpoint with no secret answers with a new signing_secret, once.

8. Rotate a Secret

The answer holds the new signing_secret. It replaces the old one at once, with no overlap, so deploy the new secret to your receiver straight away. It isn’t safe to repeat: each call replaces the secret again.

What a Merchant Credential Can’t Do

Starting a party’s identity check and requesting a capability answer 403: its partner does both. The rest of Onboard a Merchant works with the merchant’s credential, as with its partner’s. It reads the merchant’s onboarding and capabilities, which list what’s still needed, creates the legal entity, adds the owners, directors and bank accounts, and records what a person at the merchant accepts: in consent on a create, or later through POST /merchants/{id}/agreement-acceptances.