---
title: "Installment Options"
method: POST
path: "/api/v1/prepayment/installment_options"
tags: ["Prepare Payment"]
---

# Installment Options

`POST /api/v1/prepayment/installment_options`

## Request body

- PaymentOptionRequest
  - `application_key` string, required — It is the key of your application on our environment
  - `amount` integer — It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342
  - `currency` string — Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR
  - `campaign_name` string — It is the name of pos campaign you defined in our environment
  - `is_3d` boolean — It must be true for 3d payments otherwise non-3d payment. But if you send it false, it doesn't guarantee it will be non-3d. For two reasons, it can be converted to 3d payment. First the card type, debit cards must be 3d. Second case is, if there is no suitable virtual pos to process your non-3d request it will be tried to do as 3d.
  - `card_type` 'AllTypes' | 'Debit' | 'Credit' | 'Credit-Business' — An enumeration.
  - `store_code` string — If you are using physical devices you must send store code for installment options on physical devices
  - `customer_id` string — Customer id
  - `mode` string — Please send it as 'T' for test purposes, otherwise it will be in production mode.
  - `language` string — Its default value is tr. If you want to get messages in other languages, please send it. You can find supported languages in the api supported_languages.
  - `plus_inst_preferred` boolean — If there are more than one installment options for the same period, options with plus installment are preferred when this flag is true
  - `plus_inst_seperated` boolean — If there are more than one installment options for the same period, options with plus installment shown as different option when this flag is true
  - `is_submerchant_payment` boolean — Is payment for sub merchant ?
  - `is_preauth` boolean — Is payment pre auth?
  - `is_agricultural_payment` boolean — Is payment for agricultural?
  - `agricultural_code` string — Agricultural payment code. It is required when the payment is agricultural payment

## Response `200`

Successful Response

- PaymentOptionResponse
  - `response_code` string — You will get 00 for successful response, otherwise another response code for the error. You can reach the list of error codes on the Error Codes Api
  - `message` string — Here is the explanation of response code
  - `is_3d` boolean — Specifies installment options are available for 3d or none 3d payments
  - `installment_options` CardOption[]
    - `card_family_id` integer — Card Family Id
    - `card_family` string — Card Family Name
    - `card_family_logo` string — Card Family Logo
    - `card_type` 'AllTypes' | 'Debit' | 'Credit' | 'Credit-Business' — An enumeration.
    - `card_banks` CardBank[] — Card Banks
      - `id` integer — Bank Id
      - `name` string — Bank Name
      - `eft_code` string — Bank Eft Code
      - `short_name` string — Bank Short Name
      - `logo_url` string — Bank Logo
    - `currency` string — Currency
    - `inst_period` integer — Installment Period
    - `campaign_name` string — It is the name of pos campaign you defined in our environment
    - `excluded_bins` string[] — This installment count are not available for these bin codes
    - `installments` ModelsPaymentOptionResponseInstallment[] — The detailed information about possible installment options
      - `installment_count` integer — Installment Count
      - `installment_amount` number — Installment Amount
      - `cost_rate` number — Cost rate of this installment count
      - `customer_rate` number — Customer rate of this installment count
      - `additional_rate` number — Funding rate of this installment count
      - `margin_rate` number — Margin rate of this installment count
      - `min_customer_rate` number — Minimum customer rate of this installment count
      - `max_customer_rate` number — Maximum customer rate of this installment count
      - `plus_installment` integer — Plus installment count that can be used
      - `plus_installment_description` string — Plus installment description
      - `min_amount` integer — This option can bu used with mininum this amount. If it is zero there is no limitations
      - `max_amount` integer — This option can bu used with maximum this amount. If it is zero there is no limitations
    - `is_physical` boolean — Does it require a physical device
    - `physical_devices` ModelsPaymentOptionResponsePosDevice[] — Possible physical pos devices
      - `id` integer — Physical POS Device Id
      - `name` string — Physical POS Device Name
    - `bank_ids` integer[]

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/jetcheckout/apis/jet-checkout.md) · [All operations](https://skmtc.dev/jetcheckout/apis/jet-checkout/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/jetcheckout/jet-checkout/revisions/b17a3806ccb0/schema)