---
title: "Availability"
method: POST
path: "/v1/payment/orders/availability"
tags: ["Availability Services"]
---

# Availability

`POST /v1/payment/orders/availability`

You can use this service to check if the customer is eligible for the "buy now pay later" payment method. The service will return the installment options in case of success. It is available for transparent checkout only.

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Request body

- AvailabilityRequest
  - `store` object
    - `code` string — Store identifier
  - `transaction` object, required
    - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction).
    - `business_id` string — Business ID. The ID of the transaction related with this payment
    - `account` string, required — Client account number provided by Koin
    - `amount` object, required
      - `currency_code` string, required — Currency code (ISO 4217)
      - `value` number, required — Payment total amount
  - `country_code` string, required — Transaction country code (two-letter ISO 3166 country code)
  - `channel` 'API' | 'CHECKOUT' | 'LINK' | 'SDK' — Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration.
  - `payment_method` object, required
    - `code` string, required — Payment method code
  - `payer` object, required
    - `document` object, required — Payer identification document
      - `type` 'cpf', required — Payer document type
      - `number` string, required — Payer document number
    - `email` string, required — Payer email
  - `ip_address` string, required — Buyer ip address
  - `device_fingerprint` string, required — Represents the device used to initiate the payment
  - `items` union[]
    - union
      - Generic
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Generic', required — Item type
      - GenericLegacy
        - `reference` string, required — Item identifier
        - `name` string, required — Item name
        - `price` object, required — Item price
          - `currency_code` string, required — Currency code (ISO 4217)
          - `value` number, required — Amount
        - `quantity` integer, required — Item quantity
        - `discount` number, required — Item discount
        - `category` string, required — Category name
      - Financing
        - `recipient` Recipient
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Financing', required — Item type
      - CarRental
        - `car_category` string
        - `car_description` string
        - `company_name` string
        - `drivers` Person[]
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `drop_off` DropOff
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `date` string, required — Delivery date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
        - `pick_up` PickUp
          - `address` Address, required
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `date` string, required — Delivery date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'CarRental', required — Item type
      - Lodging
        - `address` Address, required
          - `address` string, required — Company address
          - `number` string, required — Company street number
          - `cep` string, required — Company cep
        - `checkin_date` string, required — Checkin date. Date format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
        - `checkout_date` string, required — Checkout date. Date format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
        - `guests` Person[] — guests
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `lodger` Lodger
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `nights` integer, required — Number of nights
        - `refundable` boolean — is refundable
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Lodging', required — Item type
      - Flight
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `itinerary_type` 'MULTIDESTINATION' | 'ONEWAY' | 'ROUND_TRIP', required — Itinerary type
        - `passengers` Passenger[], required — Passengers list
          - `id` string — Person id
          - `first_name` string, required — First name
          - `last_name` string, required — Last name
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer, required — Item quantity
        - `route_type` 'DOMESTIC' | 'INTERNATIONAL' — Route type
        - `routes` Route[], required
          - `position` integer
          - `provider` string — Route provider
          - `segments` Segment[], required — Route segments list
            - `airline_code` string — Airline code
            - `departure` DepartureAirport
              - …
            - `arrival` ArrivalAirport
              - …
            - `flight_class` string — Flight class
            - `flight_number` integer — Flight number
            - `position` integer — Segment order
        - `seller_id` string — Item seller
      - Education
        - `course` Course
          - `category` string
          - `end_date` string — Course end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `link` string — Course link
          - `monthly_fee` number — Course monthly fee
          - `name` string
          - `presential` boolean
          - `scholarship_percentage` integer — Course scholarship percentage
          - `start_date` string — Course start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `subcategory` string
        - `students` Student[]
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string, required — Person birthdate
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `email` string, required — Person email contact
          - `first_name` string, required — Person first name
          - `gender` 'FEMALE' | 'MALE' | 'OTHER', required — Person gender
          - `id` string — Person id
          - `last_name` string, required — Person last name
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
          - `relationship_with_payer` string, required — Student relationship with payer
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Education', required — Item type
      - CellphoneInsurance
        - `client` Client
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `device` Device
          - `brand` string — Device brand
          - `imei` string — International Mobile Station Equipment Identity
          - `model` string — Device model
        - `insurance` Insurance
          - `expiration_date` string, date-time. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601 
          - `installment` number
          - `subscription_date` string, date-time. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601 
          - `type` string
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'CellphoneInsurance', required — Item type
      - CarPenaltyFee
        - `car` Car
          - `brand` string — Car brand
          - `identifier` CarIdentifier
            - `key` string — Car identifier key
            - `value` string — Car identifier value
          - `license_plate` string — license plate
          - `model` string — Car model
          - `owner` Owner
            - `id` string — Client custom person identifier
            - `first_name` string — First name. Required if full_name is blank.
            - `last_name` string — Last name. Required if full_name is blank.
            - `full_name` string — Full name. Is required if first_name and last_name are blank.
            - `document` Document — Document is required if payment method is Redirection and email is blank.
              - …
            - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
            - `address` Address
              - …
            - `birth_date` string — Birthdate
            - `email` string — Email contact.
            - `phone` Phone
              - …
          - `year` string — Car year
        - `fines` Fine[]
          - `car_owning_tax_type` 'IPVA' | 'SUCIVE'
          - `car_owning_tax_amount` CarOwningTaxAmount
            - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
            - `value` number, required — Amount value
          - `fine_issued_year` integer — Fine issued year
          - `insurance_amount` InsuranceAmount
            - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
            - `value` number, required — Amount value
          - `licesing_amount` LicesingAmount
            - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
            - `value` number, required — Amount value
          - `penalty_amount` PenaltyAmount
            - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
            - `value` number, required — Amount value
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'CarPenaltyFee', required — Item type
      - TravelInsurance
        - `provider` Provider, required
          - `code` string, required — Provider code
          - `name` string, required — Provider name
        - `modality` string — Travel insurance modality
        - `region` 'NATIONAL' | 'EUROPE' | 'UNITED_STATES' | 'LATIN_AMERICA' | 'MULTI_DESTINATION' | 'OTHER', required — Travel insurance region
        - `passengers` Person[], required — List of passengers
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `service` Service, required
          - `destination` string — Service destination
          - `end_date` string, required — Service end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `id` string — Service id
          - `name` string — Service name
          - `number_of_passengers` integer, required — Number of passengers
          - `origin` string — Service origin
          - `start_date` string, required — Service start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `sub_type` string — Service subType
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'TravelInsurance', required — Item type
      - Tour
        - `provider` Provider
          - `code` string, required — Provider code
          - `name` string, required — Provider name
        - `modality` string — Tour modality
        - `description` string — Description of the product
        - `passengers_resume` PassengersResume
          - `adults` integer, required — Adults count
          - `children` integer, required — Children count
          - `infants` integer, required — Infants count
        - `passengers` Person[], required — List of passengers
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `service` Service, required
          - `destination` string — Service destination
          - `end_date` string, required — Service end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `id` string — Service id
          - `name` string — Service name
          - `number_of_passengers` integer, required — Number of passengers
          - `origin` string — Service origin
          - `start_date` string, required — Service start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `sub_type` string — Service subType
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Tour', required — Item type
      - TransferDS
        - `provider` Provider
          - `code` string, required — Provider code
          - `name` string, required — Provider name
        - `modality` string — Transfer modality
        - `description` string — Description of the product
        - `passengers_resume` PassengersResume
          - `adults` integer, required — Adults count
          - `children` integer, required — Children count
          - `infants` integer, required — Infants count
        - `passengers` Person[], required — List of passengers
          - `id` string — Client custom person identifier
          - `first_name` string — First name. Required if full_name is blank.
          - `last_name` string — Last name. Required if full_name is blank.
          - `full_name` string — Full name. Is required if first_name and last_name are blank.
          - `document` Document — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact.
          - `phone` Phone
            - `area_code` string — Phone area code. If the country code is also available, include the full combination (country code + area code) for better context, though the country code is optional.
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `service` Service, required
          - `destination` string — Service destination
          - `end_date` string, required — Service end date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `id` string — Service id
          - `name` string — Service name
          - `number_of_passengers` integer, required — Number of passengers
          - `origin` string — Service origin
          - `start_date` string, required — Service start date. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601
          - `sub_type` string — Service subType
        - `category` Category, required
          - `id` string — Item category id
          - `name` string, required — Item category name
        - `discount_amount` DiscountAmount
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `id` string, required — Item id
        - `name` string, required — item name
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer — Item quantity. Not required: default value is 1
        - `seller_id` string — Item seller
        - `service_date` string — Date which the service will take place
        - `type` 'Transfer', required — Item type
      - Bus
        - `id` string, required — Item id
        - `itinerary_type` 'MULTIDESTINATION' | 'ONEWAY' | 'ROUND_TRIP', required — Itinerary type
        - `passengers` PassengerBus[], required — Passengers list
          - `id` string — Person id
          - `first_name` string, required — First name
          - `last_name` string, required — Last name
          - `document` Document, required — Document is required if payment method is Redirection and email is blank.
            - `nationality` string — Person nationality. Two-letter country code as described in the ISO 3166 international standard
            - `number` string, required — Person document number
            - `type` string, required — Person document type
          - `gender` 'FEMALE' | 'MALE' | 'OTHER' — Gender
          - `address` Address
            - `address` string, required — Company address
            - `number` string, required — Company street number
            - `cep` string, required — Company cep
          - `birth_date` string — Birthdate
          - `email` string — Email contact
          - `phone` PhoneBus
            - `country_code` string — Transaction country code (two-letter ISO 3166 country code)
            - `area_code` string — Phone area code
            - `number` string, required — Phone number
            - `type` string — Phone type
        - `price` Price, required
          - `currency_code` string, required — Three-letter currency code as described in the ISO 4217 international standard
          - `value` number, required — Amount value
        - `quantity` integer, required — Item quantity
        - `route_type` 'DOMESTIC' | 'INTERNATIONAL' — Route type
        - `routes` RouteBus[], required
          - `position` integer, required
          - `company_name` string, required — Company name
          - `departure` DepartureBus, required
            - `city` string, required — Address city. It must be either three-letters city code or city name
            - `state` string, required — Address state. It must be either state code or state name
            - `date` string, required
            - `timezone` number, required
          - `arrival` ArrivalBus, required
            - `city` string, required — Address city. It must be either three-letters city code or city name
            - `state` string, required — Address state. It must be either state code or state name
            - `date` string, required
            - `timezone` number, required
        - `type` 'Bus', required — Item type

## Response `200`

Availability

- AvailabilityResponse
  - `status` object, required
    - `type` 'Applicable' | 'Failed', required — Availability status.
    - `reason` 'Rejected' | 'Undefined' — Availability reason.
  - `store` object
    - `code` string — Store identifier.
  - `transaction` object, required
    - `reference_id` string, required — Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction).
    - `business_id` string — Business ID. The ID of the transaction related with this payment.
    - `account` string, required — Client account number provided by Koin.
    - `amount` object, required
      - `currency_code` string, required — Currency code (ISO 4217)
      - `value` number, required — Total amount
  - `payment_method` object, required
    - `code` string, required — Payment method code
  - `country_code` string, required — Transaction country code.
  - `payer` object, required
    - `document` object, required — Payer identification document
      - `type` 'cpf', required — Payer document type
      - `number` string, required — Payer document number
    - `email` string, required — Payer email
  - `installment_options` object[] — Available installment options (when applicable)
    - `installments` integer, required — Amount of installments
    - `installment_rate` number, required — Installment rate
    - `installment_amount` number, required — Installment amount
    - `total_amount` number, required — Payment total amount
    - `first_due_date` string, date-time, required — Installment first due date (ISO 8601 date format)
    - `iof` number, required — IOF rate
    - `cet` number, required — CET rate
    - `cet_am` number, required — Monthly CET rate
    - `option_id` string, required — Installment option identifier
    - `incoming_percent_value` number — Down payment percentage
    - `incoming_value` number — Down payment amount
    - `discount` object
      - `original_installment_value` number — Original amount before applying the discount
      - `value` number — Discount amount
      - `percent` number — Discount percentage
    - `ui` object
      - `layout` object
        - `tags` string[]
        - `highlighted` boolean
        - `sorted` number
      - `hints` object
        - `birthdate` object
          - `required` boolean
  - `code` string — Standardized error code (applies only for error cases)
  - `message` string — Message associated with the error code (applies only for error cases)

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/koin/apis/payments-api.md) · [All operations](https://skmtc.dev/koin/apis/payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/koin/payments-api/revisions/6f2c01e43fe2/schema)