---
title: "Shopping Credit Options"
method: POST
path: "/api/v1/prepayment/shoppingcredit_options"
tags: ["Prepare Payment"]
---

# Shopping Credit Options

`POST /api/v1/prepayment/shoppingcredit_options`

## Request

- Base URL: `https://api.paylox.io`
- URL: `https://api.paylox.io/api/v1/prepayment/shoppingcredit_options`
- Auth: none declared
- TypeScript: <https://skmtc.dev/jetcheckout/apis/jet-checkout/docs/api/v1/prepayment/shoppingcredit_options/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- ShoppingCreditOptionRequest
  - `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
  - `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

- ShoppingCreditOptionResponse
  - `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` ShoppingCreditOption[]
    - `bank_code` string: Bank EFT Code
    - `bank_name` string: Bank Name
    - `bank_credit_desc` string: Bank Credit Description
    - `bank_logo` string: Bank Logo
    - `bank_supports_new_customer` boolean: Bank accepts new customers for credit
    - `currency` string: Currency
    - `campaign_name` string: It is the name of pos campaign you defined in our environment
    - `installments` ModelsShoppingCreditOptionResponseInstallment[]: 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
      - `min_customer_rate` number: Minimum customer rate of this installment count
      - `max_customer_rate` number: Maximum customer rate of this installment count
      - `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

## 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.dev/jetcheckout/apis/jet-checkout/revisions/06cdc5bbb97f?raw)