Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kredivo Checkout API

Initiating a Kredivo installment checkout (2-click, 0-click, QR, EDC).

Kredivo Checkout API is one of 5 APIs that Kredivo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Checkout. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 2 base URLs: https://sandbox.kredivo.com, https://{productionHost}.

2 operations 2 paths 12 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://sandbox.kredivo.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Kredivo Checkout API declares 1 security scheme for authenticating requests. An API key is passed in the header as server_key (serverKey).

  • serverKey — NOTE ON MODELLING: Kredivo does not use a header or an HTTP auth scheme. The per-merchant serverkey is sent as a field in the JSON request body of every operat…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Checkout 2

Initiating a Kredivo installment checkout (2-click, 0-click, QR, EDC).

POST
/kredivo/v2/checkout_url
Initiate a 2-click or 0-click checkout
createCheckoutUrl body → 200
POST
/offline/v1/init_checkout
Initiate a QR or EDC checkout
initOfflineCheckout body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are CheckoutRequest (15 properties), OfflineCheckoutRequest (11 properties), ProductItem (9 properties), OfflineCheckoutResponse (7 properties). Each schema is shown below with its type and property counts.

Customer
object
4 properties 3 required
CheckoutResponse
object
4 properties
TransactionDetails
object
3 properties 3 required
CheckoutRequest
object
15 properties 6 required
Address
object
7 properties 6 required
OfflineCheckoutResponse
object
7 properties
PaymentType
string
Installment tenure chosen by the shopper.
ProductItem
object
A cart line. Beyond real SKUs, Kredivo reserves the ids shippingfee, adminfee, taxfee, discount, additionalfee, insurancefee and mixpayment for non-product lin…
9 properties 4 required
ErrorDetail
object
Kredivo's error envelope. Note the API returns HTTP 200 with status ERROR.
3 properties
Seller
object
A marketplace seller. Required when the merchant is a marketplace.
6 properties 5 required
Metadata
object
Device and network signals used by Kredivo's fraud detection system.
4 properties
OfflineCheckoutRequest
object
11 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kredivo-checkout-api-openapi.yml Raw ↑

Other APIs Kredivo publishes across the network.

Kredivo Calculator API
Kredivo Confirmation API
Kredivo Tokenization API
Kredivo Transactions API