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 Payout Services API

The Payout Services API from Koin — 4 operation(s) for payout services.

Koin Payout 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 Payout Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

5 operations 4 paths 17 schemas 2 GET3 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 5

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

Payout Services 5
POST
/v1/payment/payouts/currencies
Available Cryptocurrencies
getCurrenciesPOST 2 params body → 200
POST
/v1/payment/payouts/quotation
Cryptocurrency Quotations
getQuotationsPOST 2 params body → 200
POST
/v1/payment/payouts
Create Payout
createPayoutPOST 2 params body → 200400404500
GET
/v1/payment/payouts
Get Payout by Reference ID
payoutByReferenceIdGET 3 params → 200400404500
GET
/v1/payment/payouts/{payout_id}
Get Payout
payoutByPayoutId 3 params → 200400404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are PayoutDetailResponse (9 properties), PayoutResponse (8 properties), CryptoPayoutResponse (8 properties), PayoutCrypto (6 properties). Each schema is shown below with its type and property counts.

PayoutTransaction
object
4 properties 3 required
PayoutTransactionCryptoQuotation
object
3 properties 3 required
PayoutDetailResponse
object
9 properties
PayoutResponse
object
8 properties
PayoutQuotation
object
2 properties 2 required
PayoutMethodCrypto
object
2 properties 2 required
PayoutTransactionCrypto
object
4 properties 3 required
CryptocurrenciesResponse
object
1 property
PayoutCryptoCurrencies
object
2 properties 1 required
Payout
object
5 properties 4 required
ErrorResponse
object
3 properties
PayoutMethodCryptoQuotation
object
1 property 1 required
PayoutCrypto
object
6 properties 5 required
CryptoPayoutResponse
object
8 properties
PayoutTransactionCryptoCurrencies
object
1 property 1 required
QuoteResponse
object
2 properties
PayoutPaymentMethod
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koin-payout-services-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 Ecommerce API
Koin Notification Services Sales API
Koin Onboarding Services API
Koin Payment Service Provider API
Koin Payment Services API
Koin PaymentRequest API
Koin Recipient Services Account API
Koin Refund Services API