Sign in
Prepare Payment

Softpos Options

post/api/v1/prepayment/softpos_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

card_type'AllTypes' | 'Debit' | 'Credit' | 'Credit-Business'

An enumeration.

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

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.

Example request

{
  "application_key": "6e3cdaa3-65df-4eff-aed2-9d74387701dd",
  "amount": 1250,
  "currency": "TRY",
  "campaign_name": "KAMPANYA",
  "plus_inst_seperated": true,
  "mode": "T",
  "language": "tr"
}

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

Example response

{
  "response_code": "00",
  "message": "Successful",
  "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",
      "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
        }
      ]
    }
  ]
}

Changes

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