API Reference

Complete reference documentation for all Kvell APIs. Explore endpoints, parameters, request/response examples, and authentication patterns.

CoreRecommendedOptional

Core endpoints are the minimum for a working integration. Recommended endpoints improve UX and operations. Unmarked endpoints are optional product add-ons.

Payments8 endpoints

Accept card payments and TR QR. Create checkout sessions, charge tokenized cards (3DS 2.0), preauth/capture/void, and refund.

POST/v1/payments/sessionsCoreCreate Payment Session POST/v1/payments/cardCoreCharge Tokenized Card POST/v1/payments/{id}/3ds-callbackFinalize 3DS Challenge POST/v1/payments/{id}/captureRecommendedCapture Preauthorization POST/v1/payments/{id}/voidRecommendedVoid Authorization POST/v1/payments/{id}/refundCoreRefund Payment GET/v1/payments/{id}CoreGet Payment GET/v1/payments/{id}/public-statusRecommendedPublic Payment Status

Installments2 endpoints

Look up eligible installment (taksit) plans and commission rates for a card BIN and amount, and resolve BIN metadata.

GET/v1/installmentsRecommendedBIN Installment Query GET/v1/bins/{bin}RecommendedBIN Lookup

Customers9 endpoints

Manage customer records and saved-card tokens, then charge saved cards without handling PANs.

POST/v1/customersRecommendedCreate Customer GET/v1/customers/{id}RecommendedGet Customer PUT/v1/customers/{id}Update Customer GET/v1/customersRecommendedList Customers DELETE/v1/customers/{id}Delete Customer POST/v1/customers/{id}/cardsRecommendedAttach Saved Card GET/v1/customers/{id}/cardsRecommendedList Saved Cards GET/v1/customers/{id}/cards/defaultGet Default Card DELETE/v1/customers/{id}/cards/{cardId}RecommendedDetach Saved Card

Transactions7 endpoints

Query transaction status, list with filtering and keyset pagination, inspect ledger legs, and export registries.

GET/v1/transactionsRecommendedList Transactions GET/v1/transactions/{id}RecommendedGet Transaction GET/v1/transactions/{id}/ledgerTransaction Ledger POST/v1/transactions/exportsQueue Registry Export GET/v1/transactions/exports/{exportId}Export Status GET/v1/transactions/exports/{exportId}/downloadDownload Export GET/v1/transactions/card-accessCard Access Audit

Invoices10 endpoints

Issue hosted payment links. Create, send or activate, cancel, and render PDFs; buyers pay via the public link.

POST/v1/invoicesCreate Invoice GET/v1/invoicesList Invoices GET/v1/invoices/{id}Get Invoice POST/v1/invoices/{id}/sendSend Invoice POST/v1/invoices/{id}/activateActivate Invoice (link-only)POST/v1/invoices/{id}/cancelCancel Invoice GET/v1/invoices/{id}/pdfInvoice PDF GET/v1/public/invoices/{hash}Public Invoice Read POST/v1/public/invoices/{hash}/payPay Invoice GET/v1/public/invoices/{hash}/pdfPublic Invoice PDF

Subscriptions12 endpoints

Recurring billing on saved cards. Create, pause, resume, retry, cancel, and trigger immediate charges.

POST/v1/subscriptionsCreate Subscription GET/v1/subscriptionsList Subscriptions GET/v1/subscriptions/{id}Get Subscription GET/v1/subscriptions/{id}/chargesSubscription Charges POST/v1/subscriptions/{id}/cancelCancel Subscription POST/v1/subscriptions/{id}/pausePause Subscription POST/v1/subscriptions/{id}/resumeResume Subscription POST/v1/subscriptions/{id}/retryRetry Past-Due Charge POST/v1/subscriptions/{id}/charge-nowCharge Now GET/v1/public/subscriptions/{hash}Public Subscription Read POST/v1/public/subscriptions/{hash}/cancelPublic Cancel POST/v1/public/subscriptions/{hash}/update-card-sessionUpdate Card Session

Payouts9 endpoints

Disburse to TR IBANs via FAST or EFT, or to cards via OCT. Query outstanding balances and run bulk payout drafts.

POST/v1/payoutsCreate Payout GET/v1/payoutsList Payouts GET/v1/payouts/{id}Get Payout POST/v1/payouts/{id}/cancelCancel Payout GET/v1/payouts/outstandingOutstanding Payouts POST/v1/payout-draftsCreate Bulk Payout Draft GET/v1/payout-drafts/{id}Get Payout Draft POST/v1/payout-drafts/{id}/approveApprove Payout Draft POST/v1/payout-drafts/{id}/cancelCancel Payout Draft

Disputes3 endpoints

Handle chargebacks. List chargebacks on a payment, then accept (concede) or reverse (won representment).

GET/v1/payments/{id}/chargebacksList Chargebacks POST/v1/payments/{id}/chargebacks/{cbid}/acceptAccept Chargeback POST/v1/payments/{id}/chargebacks/{cbid}/reverseReverse Chargeback

Webhooks6 endpoints

GET/v1/stores/{storeId}/webhooksCoreList Webhook Endpoints POST/v1/stores/{storeId}/webhooksCoreCreate Webhook Endpoint PATCH/v1/stores/{storeId}/webhooks/{webhookId}CoreUpdate Webhook Endpoint DELETE/v1/stores/{storeId}/webhooks/{webhookId}CoreDelete Webhook Endpoint GET/v1/merchants/{id}/webhook-deliveriesRecommendedList Webhook Deliveries POST/v1/deliveries/{id}/resendRecommendedResend Delivery

Marketplace2 endpoints

Split payments across submerchants and pay submerchants out. Onboarding and KYC are handled in the dashboard.

POST/v1/payments/sessionsSplit Payment Session POST/v1/payoutsSubmerchant Payout

Onboarding & KYC2 endpoints

Read merchant/submerchant KYC status and introspect the authenticated subject. Payments require an approved status.

GET/v1/kyc/statusKYC Status GET/v1/auth/whoamiWho Am I

Coverage Stats

Total Endpoints