Availability Services

Availability

Changed on Nov 3, 2026

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.

post/v1/payment/orders/availability

Request

Base URL
https://api-sandbox.koin.com.br
URL
https://api-sandbox.koin.com.br/v1/payment/orders/availability
Auth
none declared. Required headers: Content-Type, Accept

Headers

Content-Typestring required

The Media type of the body of the request. Default value for payment provider protocol is application/json

Acceptstring required

Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json

Request body

country_codestring required

Transaction country code (two-letter ISO 3166 country code)

channel'API' | 'CHECKOUT' | '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.

ip_addressstring required

Buyer ip address

device_fingerprintstring required

Represents the device used to initiate the payment

Example request

{
  "store": {
    "code": "SBXSTORE"
  },
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBX000",
    "amount": {
      "currency_code": "BRL",
      "value": 1500.56
    }
  },
  "country_code": "BR",
  "channel": "API",
  "payment_method": {
    "code": "BNPL"
  },
  "payer": {
    "document": {
      "number": "54672396002"
    },
    "email": "jhon_doe@domain.com"
  },
  "ip_address": "192.0.2.146",
  "device_fingerprint": "3f139f92d30d54f1aaf519b3a39a20814",
  "items": [
    {
      "category": {
        "id": "111",
        "name": "Some category name"
      },
      "discount_amount": {
        "currency_code": "USD",
        "value": 8008.99
      },
      "id": "13238487",
      "name": "Some name",
      "price": {
        "currency_code": "USD",
        "value": 8008.99
      },
      "quantity": 5,
      "seller_id": "Some Seller",
      "service_date": "2021-01-01T00:00:00.000Z"
    }
  ]
}

Response

Availability

country_codestring required

Transaction country code.

codestring

Standardized error code (applies only for error cases)

messagestring

Message associated with the error code (applies only for error cases)

Example response

{
  "store": {
    "code": "SBXSTORE"
  },
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBX000",
    "amount": {
      "currency_code": "BRL",
      "value": 1500.56
    }
  },
  "payment_method": {
    "code": "BNPL"
  },
  "country_code": "BR",
  "payer": {
    "document": {
      "number": "54672396002"
    },
    "email": "jhon_doe@domain.com"
  },
  "installment_options": [
    {
      "installments": 2,
      "installment_rate": 2.99,
      "installment_amount": 51.5,
      "total_amount": 103,
      "first_due_date": "2022-01-28T00:00:00.000Z",
      "iof": 26.18,
      "cet": 58.17,
      "cet_am": 3.84,
      "option_id": "28567e07-7296-41e7-99f1-e18df9756392",
      "incoming_percent_value": 1.2,
      "incoming_value": 10.44
    }
  ]
}

Changes

Nov 3, 20261e3734785750 Revision changes
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property ///
- breaking
  added the new required request property ///
- breaking
  added the new required request property ///
- breaking
  added the new required request property ///
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property ////
- breaking
  added the new required request property ////
- breaking
  added the new required request property ////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added the new required request property ///////
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the /////// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the /// request property allOf list
- breaking
  added to the /////// request property allOf list
- breaking
  added to the /// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the /// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ////// request property allOf list
- breaking
  added to the ////// request property allOf list
- breaking
  added to the ////// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ////// request property allOf list
- breaking
  added to the /// request property allOf list
- breaking
  request property ///// was restricted to a list of enum values
- breaking
  request property ///// was restricted to a list of enum values
- breaking
  request property ///// was restricted to a list of enum values
- breaking
  request property //// was restricted to a list of enum values
- breaking
  request property //// was restricted to a list of enum values
- breaking
  request property //// was restricted to a list of enum values
- breaking
  request property //// was restricted to a list of enum values
- breaking
  request property //// was restricted to a list of enum values
- breaking
  request property //// was restricted to a list of enum values
- breaking
  the request property ////// became required
- breaking
  the request property ///// became required
- breaking
  the request property ////// became required
- breaking
  the request property ///// became required
- breaking
  the request property ////// became required
- breaking
  the request property ///// became required
- breaking
  the request property ///// became required
- breaking
  the request property //// became required
- breaking
  the request property ///// became required
- breaking
  the request property //// became required
- breaking
  the request property ///// became required
- breaking
  the request property //// became required
- breaking
  the request property ///// became required
- breaking
  the request property ///// became required
- breaking
  the request property //// became required
- breaking
  the request property ///// became required
- breaking
  the request property //// became required
- breaking
  the request property ///// became required
- breaking
  the request property //// became required
- breaking
  removed the enum value LINK of the request property
- breaking
  the ////// request property type changed from object to no type
- breaking
  the ////// request property type changed from object to no type
- breaking
  the ////// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the /// request property type changed from object to no type
- breaking
  the /// request property type changed from boolean to no type
- breaking
  the /// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the /// request property type changed from object to no type
- breaking
  the /////// request property type changed from object to no type
- breaking
  the /////// request property type changed from object to no type
- breaking
  the /// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the //// request property format changed from date-time. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601 to date-time
- breaking
  the //// request property format changed from date-time. Format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as described in the ISO 8601 to date-time
- breaking
  the ////// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- breaking
  the ///// request property type changed from object to no type
- warning
  removed from the /// request property allOf list
- warning
  removed from the /// request property allOf list
- warning
  removed from the ///// request property allOf list
- warning
  removed from the ///// request property allOf list
- warning
  removed from the ///// request property allOf list
- warning
  removed from the ///// request property allOf list
- warning
  removed from the /////// request property allOf list
- warning
  removed from the /////// request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed from the /// request property allOf list
- warning
  removed from the /// request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  removed subschema #2 from the // request property allOf list
- warning
  changed the pattern of the request property /// from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2}
- warning
  changed the pattern of the request property //// from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2}
- warning
  changed the pattern of the request property // from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2}
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property ////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property //////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  added the new optional request property ///////
- info
  the request property //// became optional
- info
  the request property /////// became optional
- info
  the request property //// became optional
- info
  the request property /////// became optional
- info
  the request property //// became optional
- info
  the request property /////// became optional
- info
  the request property ////// became optional
- info
  the request property ////// became optional
- info
  the request property //// became optional
- info
  the request property ////// became optional
- info
  the request property ////// became optional
- info
  the request property /// became optional
- info
  the request property ///// became optional
- info
  the request property ////// became optional
- info
  the request property ////// became optional
- info
  the request property /////// became optional
- info
  added discriminator to //// request property
- info
  added discriminator to //// request property
- info
  added discriminator to //// request property
- info
  added discriminator to /// request property
- info
  added discriminator to /// request property
- info
  added discriminator to /// request property
- info
  added discriminator to /// request property
- info
  added discriminator to /// request property
- info
  added discriminator to /// request property
- info
  added the new Bus enum value to the request property /////
- info
  added the new Bus enum value to the request property /////
- info
  added the new Bus enum value to the request property /////
- info
  added the new Bus enum value to the request property ////
- info
  added the new Bus enum value to the request property ////
- info
  added the new Bus enum value to the request property ////
- info
  added the new Bus enum value to the request property ////
- info
  added the new Bus enum value to the request property ////
- info
  added the new Bus enum value to the request property ////
- info
  added the new CarPenaltyFee enum value to the request property /////
- info
  added the new CarPenaltyFee enum value to the request property /////
- info
  added the new CarPenaltyFee enum value to the request property /////
- info
  added the new CarPenaltyFee enum value to the request property ////
- info
  added the new CarPenaltyFee enum value to the request property ////
- info
  added the new CarPenaltyFee enum value to the request property ////
- info
  added the new CarPenaltyFee enum value to the request property ////
- info
  added the new CarPenaltyFee enum value to the request property ////
- info
  added the new CarPenaltyFee enum value to the request property ////
- info
  added the new CarRental enum value to the request property /////
- info
  added the new CarRental enum value to the request property /////
- info
  added the new CarRental enum value to the request property /////
- info
  added the new CarRental enum value to the request property ////
- info
  added the new CarRental enum value to the request property ////
- info
  added the new CarRental enum value to the request property ////
- info
  added the new CarRental enum value to the request property ////
- info
  added the new CarRental enum value to the request property ////
- info
  added the new CarRental enum value to the request property ////
- info
  added the new CellphoneInsurance enum value to the request property /////
- info
  added the new CellphoneInsurance enum value to the request property /////
- info
  added the new CellphoneInsurance enum value to the request property /////
- info
  added the new CellphoneInsurance enum value to the request property ////
- info
  added the new CellphoneInsurance enum value to the request property ////
- info
  added the new CellphoneInsurance enum value to the request property ////
- info
  added the new CellphoneInsurance enum value to the request property ////
- info
  added the new CellphoneInsurance enum value to the request property ////
- info
  added the new CellphoneInsurance enum value to the request property ////
- info
  added the new DestinationService enum value to the request property /////
- info
  added the new DestinationService enum value to the request property /////
- info
  added the new DestinationService enum value to the request property /////
- info
  added the new DestinationService enum value to the request property ////
- info
  added the new DestinationService enum value to the request property ////
- info
  added the new DestinationService enum value to the request property ////
- info
  added the new DestinationService enum value to the request property ////
- info
  added the new DestinationService enum value to the request property ////
- info
  added the new DestinationService enum value to the request property ////
- info
  added the new Education enum value to the request property /////
- info
  added the new Education enum value to the request property /////
- info
  added the new Education enum value to the request property /////
- info
  added the new Education enum value to the request property ////
- info
  added the new Education enum value to the request property ////
- info
  added the new Education enum value to the request property ////
- info
  added the new Education enum value to the request property ////
- info
  added the new Education enum value to the request property ////
- info
  added the new Education enum value to the request property ////
- info
  added the new Financing enum value to the request property /////
- info
  added the new Financing enum value to the request property /////
- info
  added the new Financing enum value to the request property /////
- info
  added the new Financing enum value to the request property ////
- info
  added the new Financing enum value to the request property ////
- info
  added the new Financing enum value to the request property ////
- info
  added the new Financing enum value to the request property ////
- info
  added the new Financing enum value to the request property ////
- info
  added the new Financing enum value to the request property ////
- info
  added the new Flight enum value to the request property /////
- info
  added the new Flight enum value to the request property /////
- info
  added the new Flight enum value to the request property /////
- info
  added the new Flight enum value to the request property ////
- info
  added the new Flight enum value to the request property ////
- info
  added the new Flight enum value to the request property ////
- info
  added the new Flight enum value to the request property ////
- info
  added the new Flight enum value to the request property ////
- info
  added the new Flight enum value to the request property ////
- info
  added the new Generic enum value to the request property /////
- info
  added the new Generic enum value to the request property /////
- info
  added the new Generic enum value to the request property /////
- info
  added the new Generic enum value to the request property ////
- info
  added the new Generic enum value to the request property ////
- info
  added the new Generic enum value to the request property ////
- info
  added the new Generic enum value to the request property ////
- info
  added the new Generic enum value to the request property ////
- info
  added the new Generic enum value to the request property ////
- info
  added the new Lodging enum value to the request property /////
- info
  added the new Lodging enum value to the request property /////
- info
  added the new Lodging enum value to the request property /////
- info
  added the new Lodging enum value to the request property ////
- info
  added the new Lodging enum value to the request property ////
- info
  added the new Lodging enum value to the request property ////
- info
  added the new Lodging enum value to the request property ////
- info
  added the new Lodging enum value to the request property ////
- info
  added the new Lodging enum value to the request property ////
- info
  added the new Subscription enum value to the request property /////
- info
  added the new Subscription enum value to the request property /////
- info
  added the new Subscription enum value to the request property /////
- info
  added the new Subscription enum value to the request property ////
- info
  added the new Subscription enum value to the request property ////
- info
  added the new Subscription enum value to the request property ////
- info
  added the new Subscription enum value to the request property ////
- info
  added the new Subscription enum value to the request property ////
- info
  added the new Subscription enum value to the request property ////
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status
- info
  the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status

Operation history

Availability

Request

Headers

Request body

Example request

Response 200OK

Example response

Changes

Response