Sign in
Prepare Payment

Installment Options

post/api/v1/prepayment/installment_options

Request body

application_keystring required

It is the key of your application on our environment

amountinteger

It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342

currencystring

Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR

campaign_namestring

It is the name of pos campaign you defined in our environment

is_3dboolean

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_codestring

If you are using physical devices you must send store code for installment options on physical devices

customer_idstring

Customer id

modestring

Please send it as 'T' for test purposes, otherwise it will be in production mode.

languagestring

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_preferredboolean

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_seperatedboolean

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_paymentboolean

Is payment for sub merchant ?

is_preauthboolean

Is payment pre auth?

is_agricultural_paymentboolean

Is payment for agricultural?

agricultural_codestring

Agricultural payment code. It is required when the payment is agricultural payment

Example request

{
  "application_key": "6e3cdaa3-65df-4eff-aed2-9d74387701dd",
  "amount": 1250,
  "currency": "TRY",
  "campaign_name": "KAMPANYA",
  "store_code": "M0001",
  "customer_id": "135",
  "mode": "T",
  "language": "tr",
  "plus_inst_seperated": true,
  "is_submerchant_payment": true,
  "is_preauth": true,
  "is_agricultural_payment": true,
  "agricultural_code": "1"
}

Response

Successful Response

response_codestring

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

messagestring

Here is the explanation of response code

is_3dboolean

Specifies installment options are available for 3d or none 3d payments

Example response

{
  "response_code": "00",
  "message": "Successful",
  "is_3d": true,
  "installment_options": [
    {
      "card_family_id": 5,
      "card_family": "Bonus",
      "card_family_logo": "Bonus",
      "card_banks": [
        {
          "id": 5,
          "name": "Ziraat Bankası",
          "eft_code": "064",
          "short_name": "064",
          "logo_url": "https://app.jetcheckout.com/bank/logo"
        }
      ],
      "currency": "TRY",
      "inst_period": 1,
      "campaign_name": "KAMPANYA",
      "installments": [
        {
          "installment_amount": 1.12,
          "cost_rate": 1.12,
          "customer_rate": 1.35,
          "additional_rate": 1.35,
          "margin_rate": 1.35,
          "min_customer_rate": 1.35,
          "max_customer_rate": 1.35,
          "plus_installment": 2,
          "plus_installment_description": "You can add 2 installment at electronic devices sales",
          "min_amount": 2,
          "max_amount": 2
        }
      ],
      "physical_devices": [
        {
          "name": "POS - 2"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.