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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Koin

Koin Payment Services API

The Payment Services API from Koin — 5 operation(s) for payment services.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 6 operations across 5 paths, and defines 81 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.

6 operations 5 paths 81 schemas 3 GET2 POST1 PUT

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
License
Apache License Version 2.0
Resource Areas
1

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment Services 6
POST
/v1/payment/orders
Create Payment
createPayment 2 params body → 200400404409500
GET
/v1/payment/orders
Get Payment by Reference ID
paymentByReferenceIdGET 3 params → 200400404500
GET
/v1/payment/orders/lookup
Get Payments by Transaction ID
paymentByTransactionIdGET 3 params → 200400404500
POST
/v1/payment/orders/{order_id}/capture
Capture Payment
capturePayment 3 params → 200404500
GET
/v1/payment/orders/{order_id}
Get Payment
paymentByOrderIdGET 3 params → 200400404500
PUT
/v1/payment/orders/{order_id}/cancel
Cancel Payment
cancelPaymentPUT 3 params → 200400404500

Schemas 81

The contract defines 81 schemas that model the data the API accepts and returns. The most detailed are PaymentBNPL (14 properties), PaymentCardWithCheckOut (14 properties), PaymentCardWithAntiFraud (13 properties), BNPLPaymentDetailResponse (11 properties). Each schema is shown below with its type and property counts.

PaymentBNPL
object
14 properties 10 required
Person
object
10 properties
LicesingAmount
object
Tour
object
4 properties
PaymentCardSchemas
Lodging
object
7 properties 4 required
PixPaymentResponse
object
9 properties 4 required
Insurance
object
4 properties
RefundDetailResponse
object
6 properties 3 required
PaymentPIXCheckout
object
8 properties 4 required
Course
object
9 properties
DepartureAirport
object
ErrorResponse
object
3 properties
PaymentCard
object
7 properties 5 required
CardPaymentResponse
object
9 properties 3 required
PixPaymentDetailResponse
object
11 properties 4 required
CellphoneInsurance
object
3 properties
CarDelivery
object
2 properties 2 required
Client
object
ArrivalBus
object
PaymentPixFull
Education
object
2 properties
DropOff
object
Segment
object
6 properties
GenericLegacy
object
6 properties 6 required
Shipping
object
3 properties 2 required
Item
object
9 properties 6 required
PaymentCardWithCheckOut
object
14 properties 5 required
InsuranceAmount
object
CardPaymentDetailResponse
object
10 properties 3 required
Category
object
2 properties 2 required
PassengerBus
object
9 properties 3 required
Delivery
object
3 properties 3 required
DiscountAmount
object
PaymentCardWithAntiFraud
object
13 properties 5 required
StatusRefund
object
2 properties 2 required
Subscription
object
9 properties 8 required
PaymentCardGooglePayMethod
object
3 properties 3 required
CarOwningTaxAmount
object
PaymentPIXApi
object
7 properties 4 required
RouteBus
object
4 properties 4 required
BaseAirportData
object
3 properties
Financing
object
5 properties 4 required
Device
object
3 properties
TravelInsurance
object
3 properties 2 required
Document
object
Document is required for Payment Antifraud Data if payment method is Redirection and email is blank.
3 properties 2 required
CarIdentifier
object
2 properties
BNPLPaymentDetailResponse
object
11 properties 3 required
DestinationService
object
2 properties 1 required
Passenger
object
9 properties 3 required
CarRental
object
6 properties
Student
object
10 properties 6 required
ArrivalAirport
object
PickUp
object
Owner
object
BaseBusData
object
4 properties 4 required
DepartureBus
object
Bus
object
8 properties 7 required
Lodger
object
PaymentCardMethod
object
3 properties 3 required
Generic
object
CardPaymentTransactionResponse
array
Phone
object
3 properties 1 required
Address
object
9 properties 3 required
PhoneBus
object
4 properties 1 required
Fine
object
6 properties
Service
object
8 properties 3 required
Price
object
PassengersResume
object
3 properties 3 required
TravelInsuranceProvider
object
2 properties 2 required
Amount
object
2 properties 2 required
CaptureResponse
object
5 properties 3 required
Buyer
object
11 properties
Flight
object
9 properties 5 required
CancelPaymentResponse
object
6 properties 3 required
CarPenaltyFee
object
2 properties
TransferDS
object
4 properties
Car
object
6 properties
BNPLPaymentResponse
object
10 properties 3 required
PenaltyAmount
object
Route
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koin-payment-services-api-openapi.yml Raw ↑

Other APIs Koin publishes across the network.

Koin Access API
AE Profile APIs.io
Koin Account Take Over Services API
AE Profile APIs.io
Koin Availability Services API
AE Profile APIs.io
Koin Communication Services API
AE Profile APIs.io
Koin Ecommerce API
AE Profile APIs.io
Koin Notification Services Sales API
AE Profile APIs.io
Koin Onboarding Services API
AE Profile APIs.io
Koin Payment Service Provider API
AE Profile APIs.io
Koin PaymentRequest API
AE Profile APIs.io
Koin Payout Services API
AE Profile APIs.io
Koin Recipient Services Account API
AE Profile APIs.io
Koin Refund Services API
AE Profile APIs.io
#Payment Services
← Back to K APIs
API Details
ID
koin:koin-payment-services-api
Base URL
https://api-sandbox.koin.com.br
Docs
https://api-docs.koin.com.br/reference/createpayment
Provider
Koin
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network