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

Koin Ecommerce API

The Ecommerce API from Koin — 2 operation(s) for ecommerce.

Koin Ecommerce API is one of 16 APIs that Koin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 88 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api-sandbox.koin.com.br.

2 operations 2 paths 88 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api-sandbox.koin.com.br
Resource Areas
1

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.

Ecommerce 2
POST
/v1/antifraud/pre-evaluations
Create Pre-Evaluation
createPreEvaluationUsingPOST body → 200400401500
POST
/v1/antifraud/evaluations
Create Evaluation
createEvaluationUsingPOST body → 200400401500

Schemas 88

The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are ClientInfo (17 properties), EcommerceAntiFraud (13 properties), TicketService (13 properties), TransactionData (12 properties). Each schema is shown below with its type and property counts.

PrePaidCard
object
Person
object
10 properties
BaseDeviceData
object
5 properties
Promissory
object
5 properties
LicesingAmount
object
Tour
object
4 properties
BaseCardPayment
object
7 properties 1 required
Lodging
object
7 properties 4 required
UnAuthorizedResponse
object
2 properties
Insurance
object
4 properties
Course
object
9 properties
DepartureAirport
object
Transfer
object
3 properties 2 required
GiftCard
object
3 properties
Store
object
5 properties
CellphoneInsurance
object
3 properties
CarDelivery
object
2 properties 2 required
StrategyResponse
object
6 properties
Profile
object
1 property
Client
object
Payment
object
3 properties 2 required
Points
object
1 property 3 required
PaymentAmount
object
Education
object
2 properties
DropOff
object
Segment
object
6 properties
StandardApiPreEvalResponse
object
5 properties
Shipping
object
3 properties 2 required
Item
object
9 properties 5 required
InsuranceAmount
object
Category
object
2 properties 1 required
Delivery
object
3 properties
DiscountAmount
object
CarOwningTaxAmount
object
BaseAirportData
object
3 properties
Financing
object
1 property
Device
object
3 properties
TravelInsurance
object
3 properties 2 required
StandardApiResponse
object
6 properties
TransactionData
object
12 properties 3 required
Document
object
3 properties 2 required
TicketDestinationService
object
1 property 1 required
CarIdentifier
object
2 properties
DestinationService
object
1 property 1 required
Passenger
object
9 properties 2 required
CarRental
object
6 properties
BadResponse
object
3 properties
Student
object
10 properties 6 required
ArrivalAirport
object
PickUp
object
Owner
object
CreditCard
object
1 property
Location
object
2 properties 2 required
ClientInfo
object
17 properties
Provider
object
2 properties 2 required
Cash
object
4 properties
BaseDestinationService
object
1 property 1 required
TicketService
object
13 properties 3 required
Lodger
object
Generic
object
Phone
object
3 properties 1 required
Address
object
9 properties 3 required
Wallet
object
4 properties 3 required
Payer
object
Fine
object
6 properties
Service
object
8 properties 3 required
Asynchronous
object
2 properties
Price
object
FinanceAccount
object
4 properties
PassengersResume
object
3 properties 3 required
EcommerceAntiFraud
object
13 properties 5 required
CardPaymentDetail
object
7 properties 1 required
Amount
object
2 properties 2 required
DebitCard
object
Recipient
object
3 properties
Buyer
object
AsyncPaymentDetail
object
Specific information for an asynchronous payment
Flight
object
9 properties 6 required
CarPenaltyFee
object
2 properties
StrategiesData
object
Optional data for fraud prevention strategies
6 properties
DeviceData
object
TransferDS
object
4 properties
PersonBuyer
object
11 properties 1 required
Ticket
object
5 properties
Car
object
6 properties
PenaltyAmount
object
Route
object
3 properties 1 required
PIX
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koin-ecommerce-api-openapi.yml Raw ↑

Other APIs Koin publishes across the network.

Koin Access API
Koin Account Take Over Services API
Koin Availability Services API
Koin Communication Services API
Koin Notification Services Sales API
Koin Onboarding Services API
Koin Payment Service Provider API
Koin Payment Services API
Koin PaymentRequest API
Koin Payout Services API
Koin Recipient Services Account API
Koin Refund Services API