# Quidkey Docs

- [Quidkey Documentation](https://docs.quidkey.com/index.md): Quidkey: global clearing house, optimized for modern payment workflows.
- [Onboarding](https://docs.quidkey.com/guides/onboarding/overview.md): Create your Quidkey account, complete verification, and get approved to accept live payments
- [Quickstart](https://docs.quidkey.com/quickstart.md): Get your first Quidkey payment working in minutes
- [Shopify Onboarding](https://docs.quidkey.com/guides/shopify/onboarding.md): Connect your Shopify store to Quidkey and enable Pay by Bank in your checkout
- [Embedded Flow (with Stripe)](https://docs.quidkey.com/guides/embedded-flow/overview.md): Add Quidkey bank payments alongside your existing Stripe Payment Element
- [Create a Payment Request](https://docs.quidkey.com/guides/embedded-flow/create.md): Authenticate with the API and create a payment token for the checkout iframe
- [Embed the Checkout](https://docs.quidkey.com/guides/embedded-flow/embed.md): Add the bank selection iframe alongside Stripe and wire up mutual exclusion
- [After Payment](https://docs.quidkey.com/guides/embedded-flow/after-payment.md): Handle webhooks, verify signatures, process fees, and go live
- [Payment Links](https://docs.quidkey.com/guides/payment-links/overview.md): Collect payments through a Quidkey-hosted checkout page. No frontend code required
- [Create from the Console](https://docs.quidkey.com/guides/payment-links/console.md): Create and share a payment link from the Quidkey Console - no code required
- [Create a Checkout Link](https://docs.quidkey.com/guides/payment-links/create.md): Generate a shareable checkout URL and send it to your customer
- [Checkout Experience](https://docs.quidkey.com/guides/payment-links/checkout-experience.md): What your customers see when they open a payment link
- [After Payment](https://docs.quidkey.com/guides/payment-links/after-payment.md): Track payment status, handle webhooks, and manage your payment links
- [Payout Reconciliation](https://docs.quidkey.com/guides/payouts/overview.md): View transactions per payout batch and reconcile payments with your accounting
- [Export Transactions](https://docs.quidkey.com/guides/payouts/export.md): Download transaction data as CSV or Excel for payout reconciliation
- [Monitor Your Balances](https://docs.quidkey.com/guides/balances/monitoring.md): Read live account balances and alert when the funds available for refunds run low
- [API Reference](https://docs.quidkey.com/api-reference/introduction.md): Technical overview of the Quidkey API
- [Issue a new access token](https://docs.quidkey.com/api-reference/endpoint/issue-token.md): Issue a new access token
- [Refresh an existing access token](https://docs.quidkey.com/api-reference/auth/refresh-an-existing-access-token.md): Refresh an existing access token
- [Create a payment request and return a payment_token for iframe flow](https://docs.quidkey.com/api-reference/embedded/create-a-payment-request-and-return-a-payment_token-for-iframe-flow.md): Create a payment request and return a payment_token for iframe flow
- [Update an embedded payment request (amount and/or rewards) before payment initiation](https://docs.quidkey.com/api-reference/embedded/update-an-embedded-payment-request-amount-andor-rewards-before-payment-initiation.md): Update an embedded payment request (amount and/or rewards) before payment initiation
- [Initiate a payment for an embedded flow using payment_token (query or body) and selected bank](https://docs.quidkey.com/api-reference/embedded/initiate-a-payment-for-an-embedded-flow-using-payment_token-query-or-body-and-selected-bank.md): Initiate a payment for an embedded flow using payment_token (query or body) and selected bank
- [Create a new payment link (Partner or Merchant authentication)](https://docs.quidkey.com/api-reference/payment-links/create-a-new-payment-link-partner-or-merchant-authentication.md): Create a new payment link (Partner or Merchant authentication)
- [List payment links with context-aware access control](https://docs.quidkey.com/api-reference/payment-links/list-payment-links-with-context-aware-access-control.md): List payment links with context-aware access control
- [Get payment link details by ID](https://docs.quidkey.com/api-reference/payment-links/get-payment-link-details-by-id.md): Get payment link details by ID
- [List account balances](https://docs.quidkey.com/api-reference/balances/list-account-balances.md): List live account balances for a merchant, one entry per account and currency. The account with the refund role holds the funds available for refunds. Omit merchant_id when calling with merchant credentials (resolved from the token); partner and admin callers must supply it.
- [Register or update a merchant webhook URL](https://docs.quidkey.com/api-reference/webhook/register-or-update-a-merchant-webhook-url.md): Register or update a merchant webhook URL
- [Generate a webhook signing secret for the authenticated merchant](https://docs.quidkey.com/api-reference/webhook/generate-a-webhook-signing-secret-for-the-authenticated-merchant.md): Generate a webhook signing secret for the authenticated merchant
- [Revoke the current webhook signing secret](https://docs.quidkey.com/api-reference/webhook/revoke-the-current-webhook-signing-secret.md): Revoke the current webhook signing secret
- [Payment API](https://docs.quidkey.com/guides/payment-api/overview.md): Accept bank-to-bank payments with a single API. Redirect, Embedded, or Hosted Checkout
- [Quickstart](https://docs.quidkey.com/guides/payment-api/quickstart.md): Your first Quidkey payment in about 10 minutes, end to end
- [Authentication](https://docs.quidkey.com/guides/payment-api/concepts/authentication.md): Obtain, use, and refresh OAuth 2.0 access tokens for the Payment API
- [Idempotency](https://docs.quidkey.com/guides/payment-api/concepts/idempotency.md): Safely retry create requests without producing duplicate payments
- [Errors](https://docs.quidkey.com/guides/payment-api/concepts/errors.md): Understand the error envelope, HTTP status codes, and how to handle failures
- [Webhooks](https://docs.quidkey.com/guides/payment-api/concepts/webhooks.md): Receive payment results securely: register endpoints, verify signatures, and handle events
- [Testing](https://docs.quidkey.com/guides/payment-api/concepts/testing.md): Run payments against the sandbox without moving real money
- [Amounts & Currencies](https://docs.quidkey.com/guides/payment-api/concepts/amounts-and-currencies.md): How Quidkey represents money: integer minor units and ISO 4217 currencies
- [Redirect (Pay by Bank)](https://docs.quidkey.com/guides/payment-api/accept-a-payment/redirect.md): Create a payment and redirect the buyer to a Quidkey-hosted bank page
- [Embedded (with Stripe)](https://docs.quidkey.com/guides/payment-api/accept-a-payment/embedded.md): Add Quidkey bank payments inline alongside your existing Stripe Payment Element
- [Hosted Checkout](https://docs.quidkey.com/guides/payment-api/accept-a-payment/hosted-checkout.md): Generate a shareable checkout URL in one API call. No frontend code required
- [Issue a new access token](https://docs.quidkey.com/api-reference/auth/issue-a-new-access-token.md): Issue a new access token
- [Refresh an existing access token](https://docs.quidkey.com/api-reference/auth/refresh-an-existing-access-token.md): Refresh an existing access token
- [Create a payment request via the redirect (Pay by Bank) flow](https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow.md): Create a payment request via the redirect (Pay by Bank) flow
- [Retrieve the curated top banks for a market. `country` selects the market; optional `currency` filters further; `limit` caps the result count. Public and cacheable at the market level.](https://docs.quidkey.com/api-reference/banks/retrieve-the-curated-top-banks-for-a-market-`country`-selects-the-market;-optional-`currency`-filters-further;-`limit`-caps-the-result-count-public-and-cacheable-at-the-market-level.md): Retrieve the curated top banks for a market. `country` selects the market; optional `currency` filters further; `limit` caps the result count. Public and cacheable at the market level.
- [Create a payment request and return a payment_token for iframe flow](https://docs.quidkey.com/api-reference/embedded/create-a-payment-request-and-return-a-payment_token-for-iframe-flow.md): Create a payment request and return a payment_token for iframe flow
- [Update an embedded payment request (amount and/or rewards) before payment initiation](https://docs.quidkey.com/api-reference/embedded/update-an-embedded-payment-request-amount-andor-rewards-before-payment-initiation.md): Update an embedded payment request (amount and/or rewards) before payment initiation
- [Create a new payment link (Partner or Merchant authentication)](https://docs.quidkey.com/api-reference/payment-links/create-a-new-payment-link-partner-or-merchant-authentication.md): Create a new payment link (Partner or Merchant authentication)
- [Get payment link details by ID](https://docs.quidkey.com/api-reference/payment-links/get-payment-link-details-by-id.md): Get payment link details by ID
- [Check the status of one of your payment requests by id. Documented fallback for missed webhooks.](https://docs.quidkey.com/api-reference/payments/check-the-status-of-one-of-your-payment-requests-by-id-documented-fallback-for-missed-webhooks.md): Check the status of one of your payment requests by id. Documented fallback for missed webhooks.
- [List account balances](https://docs.quidkey.com/api-reference/balances/list-account-balances.md): List live account balances for a merchant, one entry per account and currency. The account with the refund role holds the funds available for refunds. Omit merchant_id when calling with merchant credentials (resolved from the token); partner and admin callers must supply it.
- [Register or update a merchant webhook URL](https://docs.quidkey.com/api-reference/webhook/register-or-update-a-merchant-webhook-url.md): Register or update a merchant webhook URL
- [Generate a webhook signing secret for the authenticated merchant](https://docs.quidkey.com/api-reference/webhook/generate-a-webhook-signing-secret-for-the-authenticated-merchant.md): Generate a webhook signing secret for the authenticated merchant
- [Revoke the current webhook signing secret](https://docs.quidkey.com/api-reference/webhook/revoke-the-current-webhook-signing-secret.md): Revoke the current webhook signing secret

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [Blog](https://quidkey.com/blog)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.