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

# Softpos Options

`POST /api/v1/prepayment/softpos_options`

## Request body

- SoftPOSOptionRequest
  - `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
  - `card_type` 'AllTypes' | 'Debit' | 'Credit' | 'Credit-Business' — An enumeration.
  - `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
  - `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.

## Response `200`

Successful Response

- SoftPOSOptionResponse
  - `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
  - `installment_options` SoftPOSCardOption[]
    - `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
    - `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
    - `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)