Sign in
Payments

Payment

Payment api you can get payments from your customer
post/api/v1/payment

Request body

application_keystring required

It is the key of your application on our environment

campaign_namestring

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

order_idstring required

order_id must be send as unique identifier of your each request. If you send the same value in different requests it would create a chaos, you can't be sure about your payment

amountstring required

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

reward_amountstring

Card point amount used for payment. 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

installment_countstring

Its default is without installment, if you want to make installment please send the installment count as string

inst_periodinteger

Its default is 1, please send the installment period if it is different than 1

card_numberstring

Card number that will use in payment. This data never stores at our database, application logs. It is only directed to payment system.

card_holder_namestring

Cardholder name of the card that will use in payment. Our api acts like card number.

expire_monthstring

Expire month of the card. Our api acts like card number.

expire_yearstring

Expire year of the card. Please send it in four digits format whole year info not last 2 characters. Our api acts like card number.

cvcstring

Cvc of the card. Our api acts like card number.

card_tokenstring

Card token that will use in payment. It must be one of the card_owner_key's you already used for save card.

is_3dboolean required

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.

hash_datastring required

This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + CARD_NUMBER + AMOUNT + SECRET_KEY ) )

success_urlstring required

If process result is success it will be posted this url with your order_id.

fail_urlstring required

If process failed it will be posted this url with your order_id, response_code and message. You can reach our all response codes from response code api.

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.

save_cardboolean

Save Card Option

card_aliasstring

Card Alias, it is required when save card option is true

card_owner_keystring

Card Owner Unique Id in your system, it is required when save card option is true

card_owner_emailstring

Card Owner Token, it is required when save card option is true

card_customer_tokenstring

Card Customer Token in your system, it is required when save card option is true

billing_tax_officestring

Billing Tax Office Name

billing_tax_numberstring

Billing Tax Office Name

is_submerchant_paymentboolean

Is payment for sub merchant ?

submerchant_external_idstring

Submerchant Unique id in your system. It is required when the payment is submerchant payment and you dont send basket items

submerchant_pricenumber

Submerchant Payment Amount. It is required when the payment is submerchant payment and you dont send basket items

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",
  "campaign_name": "KAMPANYA",
  "order_id": "9ee3fd53-42f9-4f16-b454-77e6b714c2e9",
  "currency": "TRY",
  "installment_count": "1",
  "inst_period": 1,
  "card_number": "4508034508034509",
  "card_holder_name": "Hasan Akay",
  "expire_month": "12",
  "expire_year": "2026",
  "cvc": "000",
  "card_token": "133356090a864a579a591107cfa08cbd",
  "hash_data": "sadsaas3e412",
  "success_url": "https://api.jetcheckout.com/api/v1/merchant/success",
  "fail_url": "https://api.jetcheckout.com/api/v1/merchant/fail",
  "mode": "T",
  "language": "tr",
  "customer": {
    "email": "ahmetyigit@xyz.com",
    "name": "Ahmet",
    "surname": "Yiğit",
    "address": "Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1",
    "postal_code": "34738",
    "company": "34738",
    "phone": "+905350000000",
    "ip_address": "1.1.111.111",
    "id": "135",
    "identity_number": "74300864791",
    "county": "Konak",
    "city": "İzmir",
    "country": "Türkiye"
  },
  "customer_basket": [
    {
      "id": "KL015",
      "name": "Kalem",
      "description": "Tükenmez Mavi Kalem",
      "qty": 1,
      "is_physical": true,
      "category": "Kırtasiye",
      "submerchant_external_id": "Kırtasiye"
    }
  ],
  "billing_address": {
    "contactName": "Aysel Solmaz",
    "address": "Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1",
    "county": "Konak",
    "city": "İzmir",
    "country": "Türkiye"
  },
  "shipping_address": {
    "contactName": "Aysel Solmaz",
    "address": "Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1",
    "county": "Konak",
    "city": "İzmir",
    "country": "Türkiye"
  },
  "save_card": true,
  "card_alias": "Hasan Akay",
  "card_owner_key": "1231798798",
  "card_owner_email": "hasanakay@gmail.com",
  "card_customer_token": "1231798798",
  "billing_tax_office": "ANADOLU KURUMLAR",
  "billing_tax_number": "0980345738",
  "is_submerchant_payment": true,
  "submerchant_external_id": "Kırtasiye",
  "is_preauth": true,
  "is_agricultural_payment": true,
  "agricultural_code": "1"
}

Response

Successful Response

response_codestring

You will get 00 for successful payments, 00307 for needs redirection, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api

messagestring

Here is the explanation of response code

suggestionstring

This is the suggestion about you can take the action if the payment fails

service_resp_codestring

Payment service response code

service_resp_messagestring

Payment service response message

transaction_idstring

This is the unique id of your payment request in our system. You need to post it to redirect url when redirection needed

redirect_urlstring

If the response code is 00307 you need to redirect this url with transaction_id (that we returned in this response) on the form data

virtual_pos_namestring

Virtual pos name the payment processed

virtual_pos_idinteger

Virtual pos id the payment processed

amountnumber

Payment amount

commission_amountnumber

Payment commission amount

expected_cost_ratenumber

Payment expected cost rate

expected_cost_amountnumber

Payment expected cost amount

currencystring

Payment currency

auth_codestring

Bank authorization code

installment_countinteger

Installment Count

bin_codestring

Card Bin Code

card_typestring

Card Type

card_programstring

Card Program

card_familystring

Card Family

card_bank_eft_codestring

Card Bank Eft Code

card_bank_namestring

Card Bank Name

Example response

{
  "response_code": "00",
  "message": "Successful Payment",
  "suggestion": "Suggestion about payment success",
  "service_resp_code": "5062",
  "service_resp_message": "Gönderilen tutar tüm kırılımların toplam tutarına eşit olmalıdır",
  "transaction_id": "a9bcbe48-0543-4a0d-be41-e423b64a5550",
  "redirect_url": "https://api.jetcheckout.com/api/v1/",
  "virtual_pos_name": "Garanti Sanal Pos",
  "virtual_pos_id": 35,
  "amount": 12.5,
  "commission_amount": 0.5,
  "expected_cost_rate": 0.5,
  "expected_cost_amount": 12.5,
  "currency": "TRY",
  "auth_code": "058942",
  "bin_code": "521807",
  "card_type": "Credit",
  "card_program": "Mastercard",
  "card_family": "Axess",
  "card_bank_eft_code": "046",
  "card_bank_name": "Akbank T.A.Ş."
}

Changes

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