{"openapi":"3.0.2","info":{"title":"Jet Checkout","version":"2.1.0","x-logo":{"url":"https://api.jetcheckout.com/static/Logo.jpeg"}},"paths":{"/api/v1/prepayment/responsecodes":{"post":{"tags":["Prepare Payment"],"summary":"Response Codes","operationId":"response_codes_api_v1_prepayment_responsecodes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCodeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCodeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/payment_types":{"post":{"tags":["Prepare Payment"],"summary":"Payment Types","operationId":"payment_types_api_v1_prepayment_payment_types_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTypeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTypeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/installment_options":{"post":{"tags":["Prepare Payment"],"summary":"Installment Options","operationId":"installment_options_api_v1_prepayment_installment_options_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentOptionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentOptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/bin_installment_options":{"post":{"tags":["Prepare Payment"],"summary":"Bin Installment Options","operationId":"bin_installment_options_api_v1_prepayment_bin_installment_options_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBinRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBinResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/wallet_options":{"post":{"tags":["Prepare Payment"],"summary":"Wallet Options","operationId":"wallet_options_api_v1_prepayment_wallet_options_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletOptionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletOptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/wiretransfer_options":{"post":{"tags":["Prepare Payment"],"summary":"Wire Transfer Options","operationId":"wire_transfer_options_api_v1_prepayment_wiretransfer_options_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireTransferOptionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireTransferOptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/softpos_options":{"post":{"tags":["Prepare Payment"],"summary":"Softpos Options","operationId":"softpos_options_api_v1_prepayment_softpos_options_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftPOSOptionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftPOSOptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/shoppingcredit_options":{"post":{"tags":["Prepare Payment"],"summary":"Shopping Credit Options","operationId":"shopping_credit_options_api_v1_prepayment_shoppingcredit_options_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditOptionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditOptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/sc_itemcategories":{"post":{"tags":["Prepare Payment"],"summary":"Shopping Credit Item Categories","operationId":"shopping_credit_item_categories_api_v1_prepayment_sc_itemcategories_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScItemCategoryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScItemCategoryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/card_check":{"post":{"tags":["Prepare Payment"],"summary":"Card Check","operationId":"card_check_api_v1_prepayment_card_check_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardCheckRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardCheckResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/saved_card_query":{"post":{"tags":["Prepare Payment"],"summary":"Saved Card Query","operationId":"saved_card_query_api_v1_prepayment_saved_card_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedCardQueryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedCardQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/saved_customer_card_query":{"post":{"tags":["Prepare Payment"],"summary":"Saved Customer Card Query","operationId":"saved_customer_card_query_api_v1_prepayment_saved_customer_card_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedCustomerCardQueryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedCardCustomerQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/stores":{"post":{"tags":["Prepare Payment"],"summary":"Stores","operationId":"stores_api_v1_prepayment_stores_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/storedevices":{"post":{"tags":["Prepare Payment"],"summary":"Store Devices","operationId":"store_devices_api_v1_prepayment_storedevices_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreDeviceRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreDeviceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/storedeviceupdate":{"post":{"tags":["Prepare Payment"],"summary":"Store Device Update","operationId":"store_device_update_api_v1_prepayment_storedeviceupdate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreDeviceUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreDeviceUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/bankcodes":{"post":{"tags":["Prepare Payment"],"summary":"Bank Codes","operationId":"bank_codes_api_v1_prepayment_bankcodes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankCodeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankCodeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/listcards":{"post":{"tags":["Prepare Payment"],"summary":"List Cards","operationId":"list_cards_api_v1_prepayment_listcards_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCardsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCardsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/listcustomercards":{"post":{"tags":["Prepare Payment"],"summary":"List Customer Cards","operationId":"list_customer_cards_api_v1_prepayment_listcustomercards_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCustomerCardsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCardsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prepayment/pointinfo":{"post":{"tags":["Prepare Payment"],"summary":"Card Point Info","operationId":"card_point_info_api_v1_prepayment_pointinfo_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointInfoRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointInfoResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/hash_control":{"post":{"tags":["Payments"],"summary":"Payment Hash Control","description":"\n    Hash control api for payment you can check hash_data is correct or not\n    ","operationId":"payment_hash_control_api_v1_payment_hash_control_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HashControlRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HashControlResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/simulation":{"post":{"tags":["Payments"],"summary":"Payment Simulation","description":"\n    Payment simulation api you can check the payment request is processable \n    and which virtual pos will be used\n    ","operationId":"payment_simulation_api_v1_payment_simulation_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSimulationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSimulationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment":{"post":{"tags":["Payments"],"summary":"Payment","description":"\n    Payment api you can get payments from your customer\n    ","operationId":"payment_api_v1_payment_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResponseShown"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"callbacks":{"payment_status_changed":{"{$callback_url}":{"post":{"summary":"Payment Status Changed","operationId":"payment_status_changed__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusChangeEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__payments__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"payment_3d_finished":{"{$callback_url}":{"post":{"summary":"Payment 3D Finished","operationId":"payment_3d_finished__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment3dFinishEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__payments__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}}},"/api/v1/payment/postauth":{"post":{"tags":["Payments"],"summary":"Payment Post Auth","operationId":"payment_post_auth_api_v1_payment_postauth_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPostAuthRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPostAuthResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/status":{"post":{"tags":["Payments"],"summary":"Payment Status","operationId":"payment_status_api_v1_payment_status_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/info":{"post":{"tags":["Payments"],"summary":"Payment Info","operationId":"payment_info_api_v1_payment_info_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInfoRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInfoResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/cancel":{"post":{"tags":["Payments"],"summary":"Cancel Payment","operationId":"cancel_payment_api_v1_payment_cancel_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCancelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/refund":{"post":{"tags":["Payments"],"summary":"Refund Payment","operationId":"refund_payment_api_v1_payment_refund_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCancelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/submerchant/approve":{"post":{"tags":["Payments"],"summary":"Submerchant Payment Approve","operationId":"submerchant_payment_approve_api_v1_payment_submerchant_approve_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantPaymentApproveRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantPaymentApproveResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/submerchant/disapprove":{"post":{"tags":["Payments"],"summary":"Submerchant Payment Disapprove","operationId":"submerchant_payment_disapprove_api_v1_payment_submerchant_disapprove_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantPaymentApproveRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantPaymentApproveResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/physical/payment":{"post":{"tags":["Physical Device Payments"],"summary":"Payment","description":"\n    Physical device payment api you can start payments on your physical devices\n    ","operationId":"payment_api_v1_physical_payment_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPaymentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPaymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"callbacks":{"physical_payment_finished":{"{$callback_url}":{"post":{"summary":"Physical Payment Finished","operationId":"physical_payment_finished__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPaymentFinished"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentFinishedEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}}},"/api/v1/physical/payment/card_family":{"post":{"tags":["Physical Device Payments"],"summary":"Card Family Payment","description":"\n    Physical device payment api you can start payments on your physical devices\n    ","operationId":"card_family_payment_api_v1_physical_payment_card_family_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPaymentCardFamilyRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPaymentCardFamilyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"callbacks":{"physical_payment_finished":{"{$callback_url}":{"post":{"summary":"Physical Payment Finished","operationId":"physical_payment_finished__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPaymentFinished"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentFinishedEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}}},"/api/v1/physical/payment/finish_success":{"post":{"tags":["Physical Device Payments"],"summary":"Payment Finish Success","description":"\n    Physical device payment api you can finish payments with success\n    ","operationId":"payment_finish_success_api_v1_physical_payment_finish_success_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPaymentFinishRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPaymentFinishResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/physical/pairing":{"post":{"tags":["Physical Device Payments"],"summary":"Pairing","description":"\n    Physical device pairing request\n    ","operationId":"pairing_api_v1_physical_pairing_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalDevicePairRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhysicalPairingResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wallet/load":{"post":{"tags":["Wallet"],"summary":"Load","operationId":"load_api_v1_wallet_load_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletLoadRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletLoadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/wallet":{"post":{"tags":["Pay With Wallets"],"summary":"Pay With Wallet","description":"\n    Pay with wallet api you can get payments from your customer\n    ","operationId":"pay_with_wallet_api_v1_payment_wallet_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletPayRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletPayResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"callbacks":{"wallet_pay_status_changed":{"{$callback_url}":{"post":{"summary":"Wallet Pay Status Changed","operationId":"wallet_pay_status_changed__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletPayStatusChangeEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__wallet_pay__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"wallet_pay_finished":{"{$callback_url}":{"post":{"summary":"Wallet Pay Finished","operationId":"wallet_pay_finished__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletPayFinishEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__wallet_pay__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}}},"/api/v1/payment/wiretransfer":{"post":{"tags":["Wire Transfers"],"summary":"Wire Transfer","description":"\n    Wire transfer api you can get payments from your customer\n    ","operationId":"wire_transfer_api_v1_payment_wiretransfer_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireTransferRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireTransferResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"callbacks":{"wire_transfer_status_changed":{"{$callback_url}":{"post":{"summary":"Wire Transfer Status Changed","operationId":"wire_transfer_status_changed__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireTransferStatusChangeEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__wiretransfer__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"wire_transfer_finished":{"{$callback_url}":{"post":{"summary":"Wire Transfer Finished","operationId":"wire_transfer_finished__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireTransferFinishEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__wiretransfer__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}}},"/api/v1/payment/fast":{"post":{"tags":["Fast"],"summary":"Wire Transfer","description":"\n    Fast transfer api you can get fast request from your customer\n    ","operationId":"wire_transfer_api_v1_payment_fast_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FastRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FastResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/softpos":{"post":{"tags":["Soft POS Payments"],"summary":"Soft Pos Payment","description":"\n    Soft POS api you can get payments from your customer\n    ","operationId":"soft_pos_payment_api_v1_payment_softpos_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftPOSRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftPOSResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"callbacks":{"softpos_status_changed":{"{$callback_url}":{"post":{"summary":"Softpos Status Changed","operationId":"softpos_status_changed__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftPOSStatusChangeEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__softpos__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"softpos_payment_finished":{"{$callback_url}":{"post":{"summary":"Softpos Payment Finished","operationId":"softpos_payment_finished__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftPOSFinishEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__softpos__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}}},"/api/v1/payment/softpos/listusers":{"post":{"tags":["Soft POS Payments"],"summary":"Soft Pos List Users","description":"\n    Soft POS api you can list users who can make operations\n    ","operationId":"soft_pos_list_users_api_v1_payment_softpos_listusers_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftPosUserListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftPosUserListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/payment/shoppingcredit":{"post":{"tags":["Shopping Credit Payments"],"summary":"Shopping Credit Payment","description":"\n    Shopping Credit api you can get payments from your customer\n    ","operationId":"shopping_credit_payment_api_v1_payment_shoppingcredit_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"callbacks":{"shopping_credit_success_changed":{"{$callback_url}":{"post":{"summary":"Shopping Credit Success Changed","operationId":"shopping_credit_success_changed__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditSuccessChangeEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__shopping_credit__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"shopping_credit_status_changed":{"{$callback_url}":{"post":{"summary":"Shopping Credit Status Changed","operationId":"shopping_credit_status_changed__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditStatusChangeEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__shopping_credit__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"shopping_credit_finished":{"{$callback_url}":{"post":{"summary":"Shopping Credit Finished","operationId":"shopping_credit_finished__callback_url__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditFinishEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__shopping_credit__StatusChangeEventReceived"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}}},"/api/v1/payment/shoppingcredit/preapproved":{"post":{"tags":["Shopping Credit Payments"],"summary":"Shopping Credit Pre Approved","description":"Shopping Credit Pre Approved Offers api","operationId":"shopping_credit_pre_approved_api_v1_payment_shoppingcredit_preapproved_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditPreApprovedRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingCreditPreApprovedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/submerchant":{"put":{"tags":["Sub Merchant Operations"],"summary":"Update Submerchant","description":"\n    You can update submerchants via this api\n    ","operationId":"update_submerchant_api_v1_submerchant_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Sub Merchant Operations"],"summary":"Create Submerchant","description":"\n    You can create submerchants via this api\n    ","operationId":"create_submerchant_api_v1_submerchant_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantCreateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/submerchant/query":{"post":{"tags":["Sub Merchant Operations"],"summary":"Query Submerchant","description":"\n    You can query submerchant via this api\n    ","operationId":"query_submerchant_api_v1_submerchant_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantQueryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubMerchantResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/session":{"post":{"tags":["Embedded Checkout"],"summary":"Create Session","description":"Create a new embedded checkout session. Returns session_id and checkout_url.","operationId":"create_session_api_v1_embedded_session_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedSessionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedSessionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/session/activate":{"post":{"tags":["Embedded Checkout"],"summary":"Activate Session","description":"Activate a session and bind it to the current browser tab. Returns browser_token. Subsequent calls are rejected.","operationId":"activate_session_api_v1_embedded_session_activate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedActivateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedActivateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/merchant":{"get":{"tags":["Embedded Checkout"],"summary":"Get Merchant","description":"Get merchant credentials by merchant API key.","operationId":"get_merchant_api_v1_embedded_merchant_get","parameters":[{"required":true,"schema":{"title":"Merchant Api Key","type":"string"},"name":"merchant_api_key","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedMerchantResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/native/prepayment/bin-installment-options":{"post":{"tags":["Embedded Checkout"],"summary":"Native Bin Installment Options","description":"Proxy BIN installment options for native checkout without exposing merchant secret.","operationId":"native_bin_installment_options_api_v1_embedded_native_prepayment_bin_installment_options_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedNativeBinInstallmentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/native/payment":{"post":{"tags":["Embedded Checkout"],"summary":"Native Payment","description":"Proxy native checkout payment and generate hash server-side without exposing merchant secret.","operationId":"native_payment_api_v1_embedded_native_payment_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedNativePaymentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/payment/installment":{"post":{"tags":["Embedded Checkout"],"summary":"Payment Installment","description":"Query installment options for an embedded checkout session.","operationId":"payment_installment_api_v1_embedded_payment_installment_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedPaymentInstallmentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/payment/pay":{"post":{"tags":["Embedded Checkout"],"summary":"Payment Pay","description":"Create a payment for an embedded checkout session.","operationId":"payment_pay_api_v1_embedded_payment_pay_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedSessionPaymentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/payment/status/{order_id}":{"get":{"tags":["Embedded Checkout"],"summary":"Payment Status By Path","description":"Query payment status for an embedded checkout session.","operationId":"payment_status_by_path_api_v1_embedded_payment_status__order_id__get","parameters":[{"required":true,"schema":{"title":"Order Id","type":"string"},"name":"order_id","in":"path"},{"required":true,"schema":{"title":"Session Id","type":"string"},"name":"session_id","in":"query"},{"required":false,"schema":{"title":"Lang","type":"string"},"name":"lang","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/payment/status/":{"get":{"tags":["Embedded Checkout"],"summary":"Payment Status By Query","description":"Query payment status for an embedded checkout session.","operationId":"payment_status_by_query_api_v1_embedded_payment_status__get","parameters":[{"required":true,"schema":{"title":"Order Id","type":"string"},"name":"order_id","in":"query"},{"required":true,"schema":{"title":"Session Id","type":"string"},"name":"session_id","in":"query"},{"required":false,"schema":{"title":"Lang","type":"string"},"name":"lang","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/payment/status":{"get":{"tags":["Embedded Checkout"],"summary":"Payment Status By Query","description":"Query payment status for an embedded checkout session.","operationId":"payment_status_by_query_api_v1_embedded_payment_status_get","parameters":[{"required":true,"schema":{"title":"Order Id","type":"string"},"name":"order_id","in":"query"},{"required":true,"schema":{"title":"Session Id","type":"string"},"name":"session_id","in":"query"},{"required":false,"schema":{"title":"Lang","type":"string"},"name":"lang","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/native/hash":{"post":{"tags":["Embedded Checkout"],"summary":"Native Hash","description":"Generate payment hash server-side for legacy embedded bridge compatibility.","operationId":"native_hash_api_v1_embedded_native_hash_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedNativeHashRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/payment-hash/{session_id}":{"post":{"tags":["Embedded Checkout"],"summary":"Payment Hash","description":"Generate payment hash for a hosted checkout session without exposing merchant secret.","operationId":"payment_hash_api_v1_embedded_payment_hash__session_id__post","parameters":[{"required":true,"schema":{"title":"Session Id","type":"string"},"name":"session_id","in":"path"},{"required":true,"schema":{"title":"X-Browser-Token","type":"string"},"name":"x-browser-token","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedNativeHashRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/embedded/config/{session_id}":{"get":{"tags":["Embedded Checkout"],"summary":"Get Config","description":"Get checkout configuration for an active session. Requires X-Browser-Token header.","operationId":"get_config_api_v1_embedded_config__session_id__get","parameters":[{"required":true,"schema":{"title":"Session Id","type":"string"},"name":"session_id","in":"path"},{"required":true,"schema":{"title":"X-Browser-Token","type":"string"},"name":"x-browser-token","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedConfigResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Address":{"title":"Address","type":"object","properties":{"contactName":{"title":"Contactname","type":"string","description":"Contact name","default":"","example":"Aysel Solmaz"},"address":{"title":"Address","type":"string","description":"Address info.","default":"","example":"Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1"},"county":{"title":"County","type":"string","description":"Customer County","default":"","example":"Konak"},"city":{"title":"City","type":"string","description":"City","default":"","example":"İzmir"},"country":{"title":"Country","type":"string","description":"Country","default":"","example":"Türkiye"}}},"Bank":{"title":"Bank","type":"object","properties":{"virtual_pos_id":{"title":"Virtual Pos Id","type":"string","description":"Virtual Pos Id","default":"","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"sessionId":{"title":"Sessionid","type":"string","description":"Session Id","default":"","example":"5c340865-05ff-4c87-ae70-72d80bf30b46"},"preApprovedId":{"title":"Preapprovedid","type":"string","description":"PreApproved Id","default":"","example":"5c340865-05ff-4c87-ae70-72d80bf30b46"},"bank_code":{"title":"Bank Code","type":"string","description":"Bank EFT Code","default":"","example":"034"},"bank_name":{"title":"Bank Name","type":"string","description":"Bank Name","default":"","example":"Ziraat Bankası"},"bank_logo":{"title":"Bank Logo","type":"string","description":"Bank Logo","default":"","example":"http://app.jetchekout.com/web/image?model=jet.bank&id=2&field=avatar_128"},"bank_supports_new_customer":{"title":"Bank Supports New Customer","type":"boolean","description":"Bank accepts new customers for credit","default":false,"example":false},"installments":{"title":"Installments","type":"array","items":{"$ref":"#/components/schemas/models__shopping_credit_pre_approved_response__Installment"},"description":"The detailed information about possible installment options","default":[]}}},"BankCode":{"title":"BankCode","type":"object","properties":{"eft_code":{"title":"Eft Code","type":"string"},"name":{"title":"Name","type":"string"}}},"BankCodeRequest":{"title":"BankCodeRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"language":{"title":"Language","type":"string","description":"The language which you want to see the result","default":"tr","example":"tr"}}},"BankCodeResponse":{"title":"BankCodeResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"bank_codes":{"title":"Bank Codes","type":"array","items":{"$ref":"#/components/schemas/BankCode"},"default":[]}}},"BasketItem":{"title":"BasketItem","required":["id","name","description","qty","amount","category"],"type":"object","properties":{"id":{"title":"Id","minLength":1,"type":"string","description":"Item id","example":"KL015"},"name":{"title":"Name","minLength":1,"type":"string","description":"Name of item.","example":"Kalem"},"description":{"title":"Description","minLength":1,"type":"string","description":"Item description","example":"Tükenmez Mavi Kalem"},"qty":{"title":"Qty","type":"integer","description":"Quantiy of item","example":1},"amount":{"title":"Amount","type":"number","description":"Total amount of item","example":"10.20"},"is_physical":{"title":"Is Physical","type":"boolean","description":"Item is a physical product ?","default":false,"example":true},"category":{"title":"Category","minLength":1,"type":"string","description":"Item category","example":"Kırtasiye"},"submerchant_external_id":{"title":"Submerchant External Id","minLength":1,"type":"string","description":"Submerchant Unique Id in your system. It is required when the payment is submerchant payment.","default":"","example":"Kırtasiye"},"submerchant_price":{"title":"Submerchant Price","type":"number","description":"Submerchant Payment Amount. It is required when the payment is submerchant payment.","default":0,"example":"Kırtasiye"}}},"BinOption":{"title":"BinOption","type":"object","properties":{"card_family_id":{"title":"Card Family Id","type":"integer","description":"Card Family Id","default":0,"example":5},"card_family":{"title":"Card Family","type":"string","description":"Card Family Name","default":"","example":"Bonus"},"card_family_logo":{"title":"Card Family Logo","type":"string","description":"Card Family Logo","default":"","example":"http://app.jetchekout.com/web/image?model=jet.card.family&id=2&field=avatar_128"},"card_type":{"allOf":[{"$ref":"#/components/schemas/models__query_bin_response__CardTypeEnum"}],"description":"Card Type","default":"Credit","example":"Credit"},"currency":{"title":"Currency","type":"string","description":"Currency","default":"","example":"TRY"},"inst_period":{"title":"Inst Period","type":"integer","description":"Installment Period","default":1,"example":1},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"installments":{"title":"Installments","type":"array","items":{"$ref":"#/components/schemas/models__payment_option_response__Installment"},"description":"The detailed information about possible installment options","default":[]},"is_physical":{"title":"Is Physical","type":"boolean","description":"Does it require a physical device","default":false,"example":false},"physical_devices":{"title":"Physical Devices","type":"array","items":{"$ref":"#/components/schemas/models__query_bin_response__PosDevice"},"description":"Possible physical pos devices","default":[],"example":"[{\"id\": 3, \"name\": \"POS - 2\"}, {\"id\": 7, \"name\": \"POS - 1\"}]"}}},"CancelRequest":{"title":"CancelRequest","required":["application_key","order_id","transaction_id"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"It must be one the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"transaction_id":{"title":"Transaction Id","type":"string","description":"It must be one the transaction_id's that returned from payment transaction.","example":"8123asd23a45sf1341dasd1"},"ip_address":{"title":"Ip Address","type":"string","description":"IP address of client.","default":"","example":"1.1.111.111"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"CardBank":{"title":"CardBank","type":"object","properties":{"id":{"title":"Id","type":"integer","description":"Bank Id","default":0,"example":5},"name":{"title":"Name","type":"string","description":"Bank Name","default":"","example":"Ziraat Bankası"},"eft_code":{"title":"Eft Code","type":"string","description":"Bank Eft Code","default":"","example":"064"},"short_name":{"title":"Short Name","type":"string","description":"Bank Short Name","default":"","example":"064"},"logo_url":{"title":"Logo Url","type":"string","description":"Bank Logo","default":"","example":"https://app.jetcheckout.com/bank/logo"}}},"CardCheckRequest":{"title":"CardCheckRequest","required":["application_key","card_number"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"card_number":{"title":"Card Number","maxLength":16,"minLength":15,"type":"string","description":"Card number that will be checked.","example":"4508034508034509"},"language":{"title":"Language","type":"string","description":"The language which you want to see the response description","default":"tr","example":"tr"}}},"CardCheckResponse":{"title":"CardCheckResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"card_valid":{"title":"Card Valid","type":"boolean","description":"The card number is valid or not.","default":false,"example":true}}},"CardOption":{"title":"CardOption","type":"object","properties":{"card_family_id":{"title":"Card Family Id","type":"integer","description":"Card Family Id","default":0,"example":5},"card_family":{"title":"Card Family","type":"string","description":"Card Family Name","default":"","example":"Bonus"},"card_family_logo":{"title":"Card Family Logo","type":"string","description":"Card Family Logo","default":"","example":"Bonus"},"card_type":{"allOf":[{"$ref":"#/components/schemas/models__payment_option_response__CardTypeEnum"}],"description":"Card Type","default":"Credit","example":"Credit"},"card_banks":{"title":"Card Banks","type":"array","items":{"$ref":"#/components/schemas/CardBank"},"description":"Card Banks","default":[]},"currency":{"title":"Currency","type":"string","description":"Currency","default":"","example":"TRY"},"inst_period":{"title":"Inst Period","type":"integer","description":"Installment Period","default":1,"example":1},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"excluded_bins":{"title":"Excluded Bins","type":"array","items":{"type":"string"},"description":"This installment count are not available for these bin codes","default":[],"example":"[\"450803\", \"375622\"]"},"installments":{"title":"Installments","type":"array","items":{"$ref":"#/components/schemas/models__payment_option_response__Installment"},"description":"The detailed information about possible installment options","default":[]},"is_physical":{"title":"Is Physical","type":"boolean","description":"Does it require a physical device","default":false,"example":false},"physical_devices":{"title":"Physical Devices","type":"array","items":{"$ref":"#/components/schemas/models__payment_option_response__PosDevice"},"description":"Possible physical pos devices","default":[],"example":"[{\"id\": 3, \"name\": \"POS - 2\"}, {\"id\": 7, \"name\": \"POS - 1\"}]"},"bank_ids":{"title":"Bank Ids","type":"array","items":{"type":"integer"}}}},"CreditStatusEnum":{"title":"CreditStatusEnum","enum":["Unknown","Approved","Cancelled","Refund","PartialRefund","BankProcess","NewCustomer"],"type":"string","description":"An enumeration."},"Customer":{"title":"Customer","type":"object","properties":{"email":{"title":"Email","type":"string","description":"Email of your customer.","default":"","example":"ahmetyigit@xyz.com"},"name":{"title":"Name","type":"string","description":"Name of your customer, if you don't send it, card_holder_name will be used in required payment services.","default":"","example":"Ahmet"},"surname":{"title":"Surname","type":"string","description":"Name of your customer, if you don't send it, card_holder_name will be used in required payment services.","default":"","example":"Yiğit"},"address":{"title":"Address","type":"string","description":"Address of your customer.","default":"","example":"Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1"},"postal_code":{"title":"Postal Code","type":"string","description":"Postal code of your customer address.","default":"","example":"34738"},"company":{"title":"Company","type":"string","description":"Comapny name of your customer.","default":"","example":"34738"},"phone":{"title":"Phone","type":"string","description":"Phone number of your customer.","default":"","example":"+905350000000"},"ip_address":{"title":"Ip Address","type":"string","description":"IP address of client.","default":"","example":"1.1.111.111"},"id":{"title":"Id","type":"string","description":"Customer id","example":"135"},"identity_number":{"title":"Identity Number","type":"string","description":"Customer identity number or tax number","default":"","example":"74300864791"},"county":{"title":"County","type":"string","description":"Customer County","default":"","example":"Konak"},"city":{"title":"City","type":"string","description":"Customer City","default":"","example":"İzmir"},"country":{"title":"Country","type":"string","description":"Customer Country","default":"","example":"Türkiye"}}},"CustomerInfo":{"title":"CustomerInfo","required":["name"],"type":"object","properties":{"name":{"title":"Name","type":"string","description":"Customer Name","example":"ADZ Bilişim"},"id":{"title":"Id","type":"string","description":"Customer Id","default":"","example":"326025"}}},"EmbeddedActivateRequest":{"title":"EmbeddedActivateRequest","required":["session_id"],"type":"object","properties":{"session_id":{"title":"Session Id","type":"string","description":"Session identifier to activate","example":"ses_abc123def456"}}},"EmbeddedActivateResponse":{"title":"EmbeddedActivateResponse","required":["status","message"],"type":"object","properties":{"status":{"title":"Status","type":"integer","description":"Response code, 0 means success","example":0},"message":{"title":"Message","type":"string","description":"Response message","example":"Success"},"browser_token":{"title":"Browser Token","type":"string","description":"Browser token for single-tab binding","example":"tok_abc123def456"},"session_id":{"title":"Session Id","type":"string","description":"Session identifier"},"amount":{"title":"Amount","type":"integer","description":"Amount in minor units"},"currency":{"title":"Currency","type":"string","description":"ISO currency code"},"language":{"title":"Language","type":"string","description":"Language code"},"customer":{"title":"Customer","type":"object","description":"Customer information"},"basket_items":{"title":"Basket Items","type":"array","items":{"type":"object"},"description":"Original basket items"},"customer_basket":{"title":"Customer Basket","type":"array","items":{"type":"object"},"description":"Gateway payment customer basket"},"submerchant_external_id":{"title":"Submerchant External Id","type":"string","description":"Primary submerchant external identifier"},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Whether payment should be routed as submerchant","default":false},"campaign_name":{"title":"Campaign Name","type":"string","description":"Campaign name for payment request","default":""},"billing_tax_office":{"title":"Billing Tax Office","type":"string","description":"Billing tax office","default":""},"billing_tax_number":{"title":"Billing Tax Number","type":"string","description":"Billing tax number","default":""},"success_url":{"title":"Success Url","type":"string","description":"Merchant success callback URL"},"fail_url":{"title":"Fail Url","type":"string","description":"Merchant fail callback URL"},"payment_methods":{"title":"Payment Methods","type":"array","items":{"$ref":"#/components/schemas/EmbeddedPaymentMethod"},"description":"Available payment methods"},"merchant_name":{"title":"Merchant Name","type":"string","description":"Name of the merchant"},"merchant_config":{"title":"Merchant Config","allOf":[{"$ref":"#/components/schemas/EmbeddedMerchantConfig"}],"description":"Public merchant checkout configuration"},"checkout_options":{"title":"Checkout Options","allOf":[{"$ref":"#/components/schemas/EmbeddedCheckoutOptions"}],"description":"Checkout design and optional feature flags"}}},"EmbeddedBasketItem":{"title":"EmbeddedBasketItem","required":["id","name"],"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Unique item identifier","example":"ITEM-001"},"name":{"title":"Name","type":"string","description":"Product name","example":"Maintenance Services"},"brand_name":{"title":"Brand Name","type":"string","description":"Product brand","default":"","example":"Brand"},"qty":{"title":"Qty","type":"integer","description":"Item quantity","default":1,"example":1},"unit_price":{"title":"Unit Price","type":"integer","description":"Unit price in minor units","default":0,"example":1000},"category":{"title":"Category","type":"integer","description":"Item category code","default":0,"example":0}}},"EmbeddedCheckoutOptions":{"title":"EmbeddedCheckoutOptions","type":"object","properties":{"checkout_design":{"title":"Checkout Design","type":"string","description":"Checkout design: simple or full","default":"full","example":"full"},"show_steps":{"title":"Show Steps","type":"boolean","description":"Show steps navigation","default":true},"show_save_card":{"title":"Show Save Card","type":"boolean","description":"Show save card section","default":true},"show_installments":{"title":"Show Installments","type":"boolean","description":"Show installment options","default":true},"show_payment_summary":{"title":"Show Payment Summary","type":"boolean","description":"Show payment summary panel","default":true},"show_agreements":{"title":"Show Agreements","type":"boolean","description":"Show agreement checkboxes","default":true},"agreement_distance_sales":{"title":"Agreement Distance Sales","type":"string","description":"Distance sales agreement HTML content","default":""},"agreement_pre_information":{"title":"Agreement Pre Information","type":"string","description":"Pre-information form HTML content","default":""},"show_cancel_order":{"title":"Show Cancel Order","type":"boolean","description":"Show cancel order button on completed page","default":false},"show_refund_order":{"title":"Show Refund Order","type":"boolean","description":"Show refund order button on completed page","default":false},"point_usage_active":{"title":"Point Usage Active","type":"boolean","description":"Whether point usage is active for this merchant","default":false}}},"EmbeddedConfigResponse":{"title":"EmbeddedConfigResponse","required":["status","message"],"type":"object","properties":{"status":{"title":"Status","type":"integer","description":"Response code, 0 means success","example":0},"message":{"title":"Message","type":"string","description":"Response message","example":"Success"},"session_id":{"title":"Session Id","type":"string","description":"Session identifier","example":"ses_abc123def456"},"amount":{"title":"Amount","type":"integer","description":"Amount in minor units","example":1000},"currency":{"title":"Currency","type":"string","description":"ISO currency code","example":"TRY"},"language":{"title":"Language","type":"string","description":"Language code","example":"tr"},"customer":{"title":"Customer","type":"object","description":"Customer information"},"basket_items":{"title":"Basket Items","type":"array","items":{"type":"object"},"description":"Original basket items"},"customer_basket":{"title":"Customer Basket","type":"array","items":{"type":"object"},"description":"Gateway payment customer basket"},"submerchant_external_id":{"title":"Submerchant External Id","type":"string","description":"Primary submerchant external identifier"},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Whether payment should be routed as submerchant","default":false},"campaign_name":{"title":"Campaign Name","type":"string","description":"Campaign name for payment request","default":""},"billing_tax_office":{"title":"Billing Tax Office","type":"string","description":"Billing tax office","default":""},"billing_tax_number":{"title":"Billing Tax Number","type":"string","description":"Billing tax number","default":""},"success_url":{"title":"Success Url","type":"string","description":"Merchant success callback URL"},"fail_url":{"title":"Fail Url","type":"string","description":"Merchant fail callback URL"},"payment_methods":{"title":"Payment Methods","type":"array","items":{"$ref":"#/components/schemas/EmbeddedPaymentMethod"},"description":"Available payment methods"},"theme":{"title":"Theme","type":"object","description":"Checkout theme configuration"},"merchant_name":{"title":"Merchant Name","type":"string","description":"Name of the merchant","example":"My Store"},"merchant_config":{"title":"Merchant Config","allOf":[{"$ref":"#/components/schemas/EmbeddedMerchantConfig"}],"description":"Public merchant checkout configuration"},"checkout_options":{"title":"Checkout Options","allOf":[{"$ref":"#/components/schemas/EmbeddedCheckoutOptions"}],"description":"Checkout design and optional feature flags"}}},"EmbeddedCustomer":{"title":"EmbeddedCustomer","type":"object","properties":{"email":{"title":"Email","type":"string","description":"Customer email address","default":"","example":"test@example.com"},"name":{"title":"Name","type":"string","description":"Customer first name","default":"","example":"John"},"surname":{"title":"Surname","type":"string","description":"Customer surname","default":"","example":"Doe"},"phone":{"title":"Phone","type":"string","description":"Customer phone number","default":"","example":"+905321234567"},"address":{"title":"Address","type":"string","description":"Customer address","default":"","example":"Example Street, No: 1"},"postal_code":{"title":"Postal Code","type":"string","description":"Customer postal code","default":"","example":"34100"},"city":{"title":"City","type":"string","description":"Customer city","default":"","example":"Istanbul"},"country":{"title":"Country","type":"string","description":"Customer country code","default":"","example":"TR"},"identity_number":{"title":"Identity Number","type":"string","description":"Customer identity/VAT number","default":"","example":"12345678910"},"ip_address":{"title":"Ip Address","type":"string","description":"Customer IP address","default":"","example":"34.06.50.01"},"customer_id":{"title":"Customer Id","type":"string","description":"External customer identifier","example":"CUST-001"}}},"EmbeddedMerchantConfig":{"title":"EmbeddedMerchantConfig","type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"Jetcheckout application key","example":""},"api_base_url":{"title":"Api Base Url","type":"string","description":"Merchant API base URL","example":"https://api.jetcheckout.com/api/v1"},"mode":{"title":"Mode","type":"string","description":"Merchant mode: test or production","default":"test","example":"test"}}},"EmbeddedMerchantResponse":{"title":"EmbeddedMerchantResponse","required":["status","message"],"type":"object","properties":{"status":{"title":"Status","type":"integer","description":"Response code, 0 means success","example":0},"message":{"title":"Message","type":"string","description":"Response message","example":"Success"},"merchant_name":{"title":"Merchant Name","type":"string","description":"Name of the merchant","example":"My Store"},"api_base_url":{"title":"Api Base Url","type":"string","description":"Merchant API base URL","example":"http://localhost:8081/api/v1"},"merchant_config":{"title":"Merchant Config","allOf":[{"$ref":"#/components/schemas/EmbeddedMerchantConfig"}],"description":"Public merchant checkout configuration"}}},"EmbeddedNativeBinInstallmentRequest":{"title":"EmbeddedNativeBinInstallmentRequest","required":["amount","bin"],"type":"object","properties":{"merchant_api_key":{"title":"Merchant Api Key","type":"string","description":"Merchant API key from Paylox"},"acquirer_id":{"title":"Acquirer Id","type":"integer","description":"Escrow payment acquirer ID"},"amount":{"title":"Amount","type":"integer","description":"Amount in minor units"},"currency":{"title":"Currency","type":"string","description":"ISO currency code","default":"TRY"},"bin":{"title":"Bin","maxLength":8,"minLength":6,"type":"string","description":"Card BIN"},"campaign_name":{"title":"Campaign Name","type":"string","description":"Campaign name","default":""},"mode":{"title":"Mode","type":"string","description":"Gateway mode"},"language":{"title":"Language","type":"string","description":"Language code","default":"tr"},"is_3d":{"title":"Is 3D","type":"boolean","description":"Whether payment is 3D","default":true},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Whether submerchant routing is enabled","default":true}}},"EmbeddedNativeHashRequest":{"title":"EmbeddedNativeHashRequest","required":["amount"],"type":"object","properties":{"merchant_api_key":{"title":"Merchant Api Key","type":"string","description":"Merchant API key from Paylox"},"acquirer_id":{"title":"Acquirer Id","type":"integer","description":"Escrow payment acquirer ID"},"payment_type":{"title":"Payment Type","type":"string","description":"Payment type","default":"creditcard"},"amount":{"title":"Amount","anyOf":[{"type":"integer"},{"type":"string"}],"description":"Amount in minor units"},"card_number":{"title":"Card Number","type":"string","description":"Card number","default":""},"card_token":{"title":"Card Token","type":"string","description":"Saved card token","default":""},"order_id":{"title":"Order Id","type":"string","description":"Order identifier","default":""}}},"EmbeddedNativePaymentRequest":{"title":"EmbeddedNativePaymentRequest","required":["order_id","amount","success_url","fail_url","card_number","card_holder_name","expire_month","expire_year","cvc"],"type":"object","properties":{"merchant_api_key":{"title":"Merchant Api Key","type":"string","description":"Merchant API key from Paylox"},"acquirer_id":{"title":"Acquirer Id","type":"integer","description":"Escrow payment acquirer ID"},"order_id":{"title":"Order Id","type":"string","description":"Order identifier"},"amount":{"title":"Amount","type":"integer","description":"Amount in minor units"},"currency":{"title":"Currency","type":"string","description":"ISO currency code","default":"TRY"},"language":{"title":"Language","type":"string","description":"Language code","default":"tr"},"mode":{"title":"Mode","type":"string","description":"Gateway mode"},"success_url":{"title":"Success Url","type":"string","description":"Success callback URL"},"fail_url":{"title":"Fail Url","type":"string","description":"Fail callback URL"},"is_3d":{"title":"Is 3D","type":"boolean","description":"Whether payment is 3D","default":true},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment count","default":1},"card_number":{"title":"Card Number","type":"string","description":"Card number"},"card_holder_name":{"title":"Card Holder Name","type":"string","description":"Card holder name"},"expire_month":{"title":"Expire Month","type":"string","description":"Expiration month"},"expire_year":{"title":"Expire Year","type":"string","description":"Expiration year"},"cvc":{"title":"Cvc","type":"string","description":"Card verification code"},"customer":{"title":"Customer","type":"object"},"customer_basket":{"title":"Customer Basket","type":"array","items":{"type":"object"}},"submerchant_external_id":{"title":"Submerchant External Id","type":"string","description":"Submerchant external id","default":""},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Whether payment should be routed as submerchant","default":false},"campaign_name":{"title":"Campaign Name","type":"string","description":"Campaign name","default":""},"billing_tax_office":{"title":"Billing Tax Office","type":"string","description":"Billing tax office","default":""},"billing_tax_number":{"title":"Billing Tax Number","type":"string","description":"Billing tax number","default":""}}},"EmbeddedPaymentInstallmentRequest":{"title":"EmbeddedPaymentInstallmentRequest","required":["session_id"],"type":"object","properties":{"session_id":{"title":"Session Id","type":"string","description":"Embedded checkout session identifier"},"amount":{"title":"Amount","type":"integer","description":"Amount in minor units. Defaults to session amount."},"currency":{"title":"Currency","type":"string","description":"ISO currency code. Defaults to session currency."},"bin_number":{"title":"Bin Number","maxLength":8,"minLength":6,"type":"string","description":"Card BIN"},"bin":{"title":"Bin","maxLength":8,"minLength":6,"type":"string","description":"Card BIN"},"campaign_name":{"title":"Campaign Name","type":"string","description":"Campaign name. Defaults to session campaign."},"mode":{"title":"Mode","type":"string","description":"Gateway mode. Defaults to session mode."},"language":{"title":"Language","type":"string","description":"Language code. Defaults to session language."},"is_3d":{"title":"Is 3D","type":"boolean","description":"Whether payment is 3D","default":true},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Whether submerchant routing is enabled"}}},"EmbeddedPaymentMethod":{"title":"EmbeddedPaymentMethod","type":"object","properties":{"id":{"title":"Id","type":"integer","description":"Payment method ID","example":1},"name":{"title":"Name","type":"string","description":"Payment method name","example":"Kredi Kartı"},"payment_type":{"title":"Payment Type","type":"string","description":"Payment type code","example":"creditcard"},"description":{"title":"Description","type":"string","description":"Payment method description","example":""},"logo_url":{"title":"Logo Url","type":"string","description":"Logo image URL","example":""},"show_card_logos":{"title":"Show Card Logos","type":"boolean","description":"Whether to display card brand logos","default":false},"is_sponsored":{"title":"Is Sponsored","type":"boolean","description":"Whether this method is sponsored","default":false},"is_active":{"title":"Is Active","type":"boolean","description":"Whether this method is active","default":true},"sequence":{"title":"Sequence","type":"integer","description":"Display order","default":10,"example":10}}},"EmbeddedSessionPaymentRequest":{"title":"EmbeddedSessionPaymentRequest","required":["session_id","card_number","card_holder_name","expire_month","expire_year","cvc"],"type":"object","properties":{"session_id":{"title":"Session Id","type":"string","description":"Embedded checkout session identifier"},"payment_type":{"title":"Payment Type","type":"string","description":"Payment type","default":"creditcard"},"order_id":{"title":"Order Id","type":"string","description":"Order identifier. Defaults to metadata order_id or session_id."},"amount":{"title":"Amount","anyOf":[{"type":"integer"},{"type":"string"}],"description":"Amount in minor units. Defaults to session amount."},"currency":{"title":"Currency","type":"string","description":"ISO currency code. Defaults to session currency."},"language":{"title":"Language","type":"string","description":"Language code. Defaults to session language."},"mode":{"title":"Mode","type":"string","description":"Gateway mode. Defaults to session mode."},"success_url":{"title":"Success Url","type":"string","description":"Success callback URL. Defaults to session success_url."},"fail_url":{"title":"Fail Url","type":"string","description":"Fail callback URL. Defaults to session fail_url."},"is_3d":{"title":"Is 3D","type":"boolean","description":"Whether payment is 3D","default":true},"installment_count":{"title":"Installment Count","anyOf":[{"type":"integer"},{"type":"string"}],"description":"Installment count","default":1},"card_number":{"title":"Card Number","type":"string","description":"Card number"},"card_holder_name":{"title":"Card Holder Name","type":"string","description":"Card holder name"},"expire_month":{"title":"Expire Month","type":"string","description":"Expiration month"},"expire_year":{"title":"Expire Year","type":"string","description":"Expiration year"},"cvc":{"title":"Cvc","type":"string","description":"Card verification code"},"customer":{"title":"Customer","type":"object","description":"Customer information. Defaults to session customer."},"customer_basket":{"title":"Customer Basket","type":"array","items":{"type":"object"},"description":"Basket information. Defaults to session basket."},"submerchant_external_id":{"title":"Submerchant External Id","type":"string","description":"Submerchant external id"},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Whether payment should be routed as submerchant"},"campaign_name":{"title":"Campaign Name","type":"string","description":"Campaign name"},"billing_tax_office":{"title":"Billing Tax Office","type":"string","description":"Billing tax office"},"billing_tax_number":{"title":"Billing Tax Number","type":"string","description":"Billing tax number"}}},"EmbeddedSessionRequest":{"title":"EmbeddedSessionRequest","required":["merchant_api_key","amount"],"type":"object","properties":{"merchant_api_key":{"title":"Merchant Api Key","type":"string","description":"Merchant API key from Paylox","example":"1x2cdaa3-35df-2eff-aeq2-5d74387701xd"},"amount":{"title":"Amount","type":"integer","description":"Amount in minor units (e.g. 1000 = 10.00 TRY)","example":1000},"currency":{"title":"Currency","type":"string","description":"ISO currency code","default":"TRY","example":"TRY"},"language":{"title":"Language","type":"string","description":"Language code","default":"tr","example":"tr"},"customer":{"title":"Customer","allOf":[{"$ref":"#/components/schemas/EmbeddedCustomer"}],"description":"Customer information"},"basket_items":{"title":"Basket Items","type":"array","items":{"$ref":"#/components/schemas/EmbeddedBasketItem"},"description":"List of basket items"},"customer_basket":{"title":"Customer Basket","type":"array","items":{"type":"object"},"description":"Gateway payment customer basket"},"submerchant_external_id":{"title":"Submerchant External Id","type":"string","description":"Primary submerchant external identifier","default":""},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Whether payment should be routed as submerchant","default":false},"campaign_name":{"title":"Campaign Name","type":"string","description":"Campaign name for payment request","default":""},"billing_tax_office":{"title":"Billing Tax Office","type":"string","description":"Billing tax office","default":""},"billing_tax_number":{"title":"Billing Tax Number","type":"string","description":"Billing tax number","default":""},"success_url":{"title":"Success Url","type":"string","description":"Merchant success callback URL","example":"https://example.com/success"},"fail_url":{"title":"Fail Url","type":"string","description":"Merchant fail callback URL","example":"https://example.com/fail"},"metadata":{"title":"Metadata","type":"object","description":"Arbitrary metadata to pass through"}}},"EmbeddedSessionResponse":{"title":"EmbeddedSessionResponse","required":["status","message"],"type":"object","properties":{"status":{"title":"Status","type":"integer","description":"Response code, 0 means success","example":0},"message":{"title":"Message","type":"string","description":"Response message","example":"Success"},"session_id":{"title":"Session Id","type":"string","description":"Unique session identifier","example":"ses_abc123def456"},"checkout_url":{"title":"Checkout Url","type":"string","description":"URL to redirect for payment","example":"https://example.com/embedded/checkout?session=ses_abc123"},"expires_at":{"title":"Expires At","type":"string","description":"Session expiration datetime in ISO format","example":"2025-01-01T01:00:00+00:00"}}},"FastCustomer":{"title":"FastCustomer","required":["nationalIdentityNumber"],"type":"object","properties":{"email":{"title":"Email","type":"string","description":"Email of your customer.","default":"","example":"ahmetyigit@xyz.com"},"nationalIdentityNumber":{"title":"Nationalidentitynumber","type":"string","description":"Customer TC number","example":""},"ip_address":{"title":"Ip Address","type":"string","description":"IP address of client.","default":"","example":"1.1.111.111"}}},"FastRequest":{"title":"FastRequest","required":["application_key","order_id","amount","hash_data","customer"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"order_id must be send as unique identifier of your each request.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"number","description":"Total amount","example":1250.42},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + ORDER_ID + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"customer":{"title":"Customer","allOf":[{"$ref":"#/components/schemas/FastCustomer"}],"description":"Customer information. Our api acts like card number."}}},"FastResponse":{"title":"FastResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string"},"message":{"title":"Message","type":"string"},"suggestion":{"title":"Suggestion","type":"string","default":""},"service_resp_code":{"title":"Service Resp Code","type":"string","default":""},"service_resp_message":{"title":"Service Resp Message","type":"string","default":""},"transaction_id":{"title":"Transaction Id","type":"string"},"redirect_url":{"title":"Redirect Url","type":"string"}}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"HashControlRequest":{"title":"HashControlRequest","required":["application_key","amount","card_number","hash_data"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"amount":{"title":"Amount","type":"integer","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"card_number":{"title":"Card Number","minLength":3,"type":"string","description":"Card number that will use in payment. This data never stores at our database, application logs. It is only directed to payment system.","example":"4508034508034509"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + CARD_NUMBER + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"HashControlResponse":{"title":"HashControlResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"You will get 00 for successful response, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful"},"hash_explanation":{"title":"Hash Explanation","type":"string","description":"Explanation of how to calculate hash value","default":"","example":""},"hash_sample_key":{"title":"Hash Sample Key","type":"string","description":"This is the sample hash key for the secret key 12345678","default":"","example":""},"hash_sample_value":{"title":"Hash Sample Value","type":"string","description":"This is the sample hash value for the secret key 12345678","default":"","example":""}}},"ListCardsRequest":{"title":"ListCardsRequest","required":["application_key","card_owner_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"card_owner_key":{"title":"Card Owner Key","type":"string","description":"It is the key of card owner","example":"123897"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"The language which you want to see the result","default":"tr","example":"tr"}}},"ListCardsResponse":{"title":"ListCardsResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"cards":{"title":"Cards","type":"array","items":{"$ref":"#/components/schemas/StoredCard"},"default":[]}}},"ListCustomerCardsRequest":{"title":"ListCustomerCardsRequest","required":["application_key","card_customer_token"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"card_customer_token":{"title":"Card Customer Token","type":"string","description":"It is Customer Token","example":"123897"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"The language which you want to see the result","default":"tr","example":"tr"}}},"PayItem":{"title":"PayItem","required":["amount","payment_type"],"type":"object","properties":{"amount":{"title":"Amount","type":"number","description":"Payment amount","example":10.2},"payment_type":{"title":"Payment Type","type":"integer","description":"Payment Type. Acceptable Payment Types 1 (Cash), 2 (Foreign Cash), 3 (Credit Card)","example":1},"installment_no":{"title":"Installment No","type":"integer","description":"Payment Installment No","default":0,"example":"250001"},"credit_id":{"title":"Credit Id","type":"integer","description":"Payment Credit Id","default":0,"example":2},"definition":{"title":"Definition","type":"string","description":"Payment Definition","default":"","example":""},"reference_code":{"title":"Reference Code","type":"string","description":"Payment Reference Code","default":"","example":""},"issuer_id":{"title":"Issuer Id","type":"string","description":"Payment Issuer Id","default":"","example":"1"},"card_number":{"title":"Card Number","type":"string","description":"Payment Card Number","default":"","example":"1"},"acquire_id":{"title":"Acquire Id","type":"string","description":"Payment Acquire Id","default":"","example":"1"}}},"Payment3dFinishEvent":{"title":"Payment3dFinishEvent","required":["transaction_id","order_id","response_code","response_message","virtual_pos_name","virtual_pos_id","amount","commission_amount","expected_cost_rate","expected_cost_amount","currency","auth_code","installment_count","hash_data"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"response_code":{"title":"Response Code","type":"string","description":"00 means it is successful, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"response_message":{"title":"Response Message","type":"string","description":"Here is the explanation of response code","example":"Here is the payment info"},"suggestion":{"title":"Suggestion","type":"string","description":"This is the suggestion about you can take the action if the payment fails ","default":"","example":"Suggestion about payment success"},"service_resp_code":{"title":"Service Resp Code","type":"string","description":"Payment service response code","default":"","example":"5062"},"service_resp_message":{"title":"Service Resp Message","type":"string","description":"Payment service response message","default":"","example":"Gönderilen tutar tüm kırılımların toplam tutarına eşit olmalıdır"},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"Virtual pos name the payment had been processed","example":"Garanti Sanal Pos"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment had been processed","example":35},"amount":{"title":"Amount","type":"number","description":"Payment requested amount","example":12.5},"commission_amount":{"title":"Commission Amount","type":"number","description":"Payment commission amount","example":0.5},"expected_cost_rate":{"title":"Expected Cost Rate","type":"number","description":"Payment expected cost rate","example":0.5},"expected_cost_amount":{"title":"Expected Cost Amount","type":"number","description":"Payment expected cost amount","example":12.5},"currency":{"title":"Currency","type":"string","description":"Payment currency","example":"TRY"},"auth_code":{"title":"Auth Code","type":"string","description":"Bank authorization code","example":"058942"},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment Count","example":"1"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the hash data for check. BASE_64_ENCODE( SHA_256( order_id + response_code + application_secret_key ) )","example":"sadsaas3e412"}}},"PaymentCancelResponse":{"title":"PaymentCancelResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"You will get 00 for successful cancel/refund operation, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successfully Cancelled"},"suggestion":{"title":"Suggestion","type":"string","description":"This is the suggestion about you can take the action if the payment fails ","default":"","example":"Suggestion about operation success"},"service_resp_code":{"title":"Service Resp Code","type":"string","description":"Payment service response code","default":"","example":"7804"},"service_resp_message":{"title":"Service Resp Message","type":"string","description":"Payment service response message","default":"","example":"İptal işlemi aynı gün yapılmalıdır."}}},"PaymentCancelTransaction":{"title":"PaymentCancelTransaction","type":"object","properties":{"id":{"title":"Id","type":"integer","default":0},"transaction_id":{"title":"Transaction Id","type":"integer"},"transaction_date":{"title":"Transaction Date","type":"string"},"is_success":{"title":"Is Success","type":"boolean"},"amount":{"title":"Amount","type":"number"},"response_code":{"title":"Response Code","type":"string"},"response_message":{"title":"Response Message","type":"string"},"process_type":{"title":"Process Type","type":"string"},"completed":{"title":"Completed","type":"boolean"}}},"PaymentFinishedEventReceived":{"title":"PaymentFinishedEventReceived","type":"object","properties":{"ok":{"title":"Ok","type":"string","description":"Payment is Successful","default":"OK","example":"OK"}}},"PaymentInfo":{"title":"PaymentInfo","type":"object","properties":{"order_id":{"title":"Order Id","type":"string","description":"The queried order_id","example":"order-hugin-0921341"},"transaction_id":{"title":"Transaction Id","type":"string","description":"Unique id of payment order in our system","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"transaction_date":{"title":"Transaction Date","type":"string","description":"Payment transaction date","example":"2021-12-09 00:13:35"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment had been processed","example":35},"is_success":{"title":"Is Success","type":"boolean","description":"Describes the payment is successful or not","example":true},"completed":{"title":"Completed","type":"boolean","description":"Describes the payment is completed or not","example":true},"is_3d":{"title":"Is 3D","type":"boolean","description":"Describes the payment is done with 3d secure process","example":true},"credit_bank":{"title":"Credit Bank","type":"string","description":"Credit Bank EFT Code","example":"00"},"preauth":{"title":"Preauth","type":"boolean","description":"Payment is pre auth ?","default":false,"example":true},"postauth":{"title":"Postauth","type":"boolean","description":"Pre auth payment is approved ?","default":false,"example":true},"currency":{"title":"Currency","type":"string","description":"Payment currency","example":"TRY"},"amount":{"title":"Amount","type":"number","description":"Payment requested amount","example":12.5},"paid_amount":{"title":"Paid Amount","type":"number","description":"Payment amount","example":12.5},"rem_amount":{"title":"Rem Amount","type":"number","description":"Remaining Payment amount","example":12.5},"refund_amount":{"title":"Refund Amount","type":"number","description":"Payment refund amount","example":2.7},"cancelled":{"title":"Cancelled","type":"boolean","description":"It is true if the payment cancelled on same day","example":false},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment count","default":1,"example":1},"inst_period":{"title":"Inst Period","type":"integer","description":"Installment period","default":1,"example":1},"pos_bank_eft_code":{"title":"Pos Bank Eft Code","type":"string","description":"Pos Bank Eft Code","example":"15"},"pos_bank_name":{"title":"Pos Bank Name","type":"string","description":"Pos Bank Name","example":"T.VAKIFLAR BANKASI T.A.O."},"payment_response_code":{"title":"Payment Response Code","type":"string","description":"Payment response code","example":"00"},"payment_response_message":{"title":"Payment Response Message","type":"string","description":"Payment response message","example":"00"},"error_message":{"title":"Error Message","type":"string","description":"Error message","example":"00"},"payment_system":{"title":"Payment System","type":"string","description":"Payment System","example":"GARANTI"},"request_log":{"title":"Request Log","type":"string","description":"Log of the payment info request","example":"Request log details"},"response_log":{"title":"Response Log","type":"string","description":"Log of the payment info response","example":"Response log details"}}},"PaymentInfoRequest":{"title":"PaymentInfoRequest","required":["application_key","start_date","end_date"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"lang":{"title":"Lang","type":"string","description":"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.","default":"tr","example":"tr"},"start_date":{"title":"Start Date","type":"string","description":"Start datetime in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM)","format":"date-time","example":"2025-12-11T00:00:00+03:00"},"end_date":{"title":"End Date","type":"string","description":"End datetime in ISO 8601 format (YYYY-MM-DDTHH:MM:SS±HH:MM)","format":"date-time","example":"2025-12-17T23:59:59+03:00"}}},"PaymentInfoResponse":{"title":"PaymentInfoResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"The status of query operation. 00200 means it is successful, 00404 means no transaction with the queried order_id","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Here is the payment info"},"payments":{"title":"Payments","type":"array","items":{"$ref":"#/components/schemas/PaymentInfo"},"description":"List of payment information records"}}},"PaymentItem":{"title":"PaymentItem","required":["amount","bank_code","auth_code","installment_count"],"type":"object","properties":{"amount":{"title":"Amount","type":"number","description":"Payment amount","example":10.2},"payment_type":{"title":"Payment Type","type":"integer","description":"Payment Type","example":3},"bank_code":{"title":"Bank Code","type":"string","description":"Acquirer bank code","example":"0015"},"auth_code":{"title":"Auth Code","type":"string","description":"Bank reference code","example":"128467"},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment count","example":3},"bin_code":{"title":"Bin Code","type":"string","description":"Payment Card Bin Code","example":"521807"},"card_type":{"title":"Card Type","type":"string","description":"Card Type","example":"Credit"},"card_program":{"title":"Card Program","type":"string","description":"Card Program","example":"Mastercard"},"card_family":{"title":"Card Family","type":"string","description":"Card Family","example":"Axess"},"card_bank_eft_code":{"title":"Card Bank Eft Code","type":"string","description":"Card Bank Eft Code","example":"046"},"card_bank_name":{"title":"Card Bank Name","type":"string","description":"Card Bank Name","example":"Akbank T.A.Ş."}}},"PaymentOptionRequest":{"title":"PaymentOptionRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"amount":{"title":"Amount","type":"integer","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","default":0,"example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"is_3d":{"title":"Is 3D","type":"boolean","description":"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.","default":true,"example":false},"card_type":{"allOf":[{"$ref":"#/components/schemas/models__payment_option_response__CardTypeEnum"}],"description":"Card Type","default":"AllTypes","example":"Credit"},"store_code":{"title":"Store Code","type":"string","description":"If you are using physical devices you must send store code for installment options on physical devices","default":"","example":"M0001"},"customer_id":{"title":"Customer Id","type":"string","description":"Customer id","example":"135"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"plus_inst_preferred":{"title":"Plus Inst Preferred","type":"boolean","description":"If there are more than one installment options for the same period, options with plus installment are preferred when this flag is true","default":true,"example":false},"plus_inst_seperated":{"title":"Plus Inst Seperated","type":"boolean","description":"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","default":false,"example":true},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Is payment for sub merchant ?","example":true},"is_preauth":{"title":"Is Preauth","type":"boolean","description":"Is payment pre auth?","example":true},"is_agricultural_payment":{"title":"Is Agricultural Payment","type":"boolean","description":"Is payment for agricultural?","example":true},"agricultural_code":{"title":"Agricultural Code","type":"string","description":"Agricultural payment code. It is required when the payment is agricultural payment","example":"1"}}},"PaymentOptionResponse":{"title":"PaymentOptionResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"is_3d":{"title":"Is 3D","type":"boolean","description":"Specifies installment options are available for 3d or none 3d payments","default":true,"example":true},"installment_options":{"title":"Installment Options","type":"array","items":{"$ref":"#/components/schemas/CardOption"},"default":[]}}},"PaymentPostAuthRequest":{"title":"PaymentPostAuthRequest","required":["application_key","transaction_id","amount","ip_address"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"transaction_id":{"title":"Transaction Id","type":"string","description":"It must be one the transaction_id's that returned from payment transaction.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"string","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"ip_address":{"title":"Ip Address","type":"string","description":"IP address of client.","example":"1.1.111.111"},"lang":{"title":"Lang","type":"string","description":"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.","default":"tr","example":"tr"}}},"PaymentPostAuthResponse":{"title":"PaymentPostAuthResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"You will get 00 for successful response, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful"},"suggestion":{"title":"Suggestion","type":"string","description":"This is the suggestion about you can take the action if the payment fails ","default":"","example":"Suggestion about operation success"},"service_resp_code":{"title":"Service Resp Code","type":"string","description":"Here is the service error code","example":"5082"},"service_resp_message":{"title":"Service Resp Message","type":"string","description":"Here is the service error message","example":"5082"}}},"PaymentRequest":{"title":"PaymentRequest","required":["application_key","order_id","amount","is_3d","hash_data","success_url","fail_url"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"order_id":{"title":"Order Id","type":"string","description":"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","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"string","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"reward_amount":{"title":"Reward Amount","type":"string","description":"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","default":"","example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"installment_count":{"title":"Installment Count","type":"string","description":"Its default is without installment, if you want to make installment please send the installment count as string","example":"1"},"inst_period":{"title":"Inst Period","type":"integer","description":"Its default is 1, please send the installment period if it is different than 1","default":1,"example":1},"card_number":{"title":"Card Number","maxLength":16,"minLength":15,"type":"string","description":"Card number that will use in payment. This data never stores at our database, application logs. It is only directed to payment system.","example":"4508034508034509"},"card_holder_name":{"title":"Card Holder Name","type":"string","description":"Cardholder name of the card that will use in payment. Our api acts like card number.","example":"Hasan Akay"},"expire_month":{"title":"Expire Month","maxLength":2,"minLength":1,"pattern":"^[0-9]*$","type":"string","description":"Expire month of the card. Our api acts like card number.","example":"12"},"expire_year":{"title":"Expire Year","maxLength":4,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"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.","example":"2026"},"cvc":{"title":"Cvc","type":"string","description":"Cvc of the card. Our api acts like card number.","example":"000"},"card_token":{"title":"Card Token","type":"string","description":"Card token that will use in payment. It must be one of the card_owner_key's you already used for save card.","example":"133356090a864a579a591107cfa08cbd"},"is_3d":{"title":"Is 3D","type":"boolean","description":"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.","example":false},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + CARD_NUMBER + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"success_url":{"title":"Success Url","type":"string","description":"If process result is success it will be posted this url with your order_id.","example":"https://api.jetcheckout.com/api/v1/merchant/success"},"fail_url":{"title":"Fail Url","type":"string","description":"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.","example":"https://api.jetcheckout.com/api/v1/merchant/fail"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"customer":{"title":"Customer","allOf":[{"$ref":"#/components/schemas/Customer"}],"description":"Customer information. Our api acts like card number."},"customer_basket":{"title":"Customer Basket","type":"array","items":{"$ref":"#/components/schemas/BasketItem"},"description":"Content of order. Our api acts like card number."},"billing_address":{"title":"Billing Address","allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Billing address. Our api acts like card number."},"shipping_address":{"title":"Shipping Address","allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Shipping address. Our api acts like card number."},"save_card":{"title":"Save Card","type":"boolean","description":"Save Card Option","default":false,"example":true},"card_alias":{"title":"Card Alias","type":"string","description":"Card Alias, it is required when save card option is true","example":"Hasan Akay"},"card_owner_key":{"title":"Card Owner Key","type":"string","description":"Card Owner Unique Id in your system, it is required when save card option is true","example":"1231798798"},"card_owner_email":{"title":"Card Owner Email","type":"string","description":"Card Owner Token, it is required when save card option is true","example":"hasanakay@gmail.com"},"card_customer_token":{"title":"Card Customer Token","type":"string","description":"Card Customer Token in your system, it is required when save card option is true","example":"1231798798"},"billing_tax_office":{"title":"Billing Tax Office","type":"string","description":"Billing Tax Office Name","example":"ANADOLU KURUMLAR"},"billing_tax_number":{"title":"Billing Tax Number","maxLength":11,"minLength":10,"type":"string","description":"Billing Tax Office Name","example":"0980345738"},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Is payment for sub merchant ?","example":true},"submerchant_external_id":{"title":"Submerchant External Id","minLength":1,"type":"string","description":"Submerchant Unique id in your system. It is required when the payment is submerchant payment and you dont send basket items","default":"","example":"Kırtasiye"},"submerchant_price":{"title":"Submerchant Price","type":"number","description":"Submerchant Payment Amount. It is required when the payment is submerchant payment and you dont send basket items","default":0,"example":"Kırtasiye"},"is_preauth":{"title":"Is Preauth","type":"boolean","description":"Is payment pre auth?","example":true},"is_agricultural_payment":{"title":"Is Agricultural Payment","type":"boolean","description":"Is payment for agricultural?","example":true},"agricultural_code":{"title":"Agricultural Code","type":"string","description":"Agricultural payment code. It is required when the payment is agricultural payment","example":"1"}}},"PaymentResponseShown":{"title":"PaymentResponseShown","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful Payment"},"suggestion":{"title":"Suggestion","type":"string","description":"This is the suggestion about you can take the action if the payment fails ","default":"","example":"Suggestion about payment success"},"service_resp_code":{"title":"Service Resp Code","type":"string","description":"Payment service response code","default":"","example":"5062"},"service_resp_message":{"title":"Service Resp Message","type":"string","description":"Payment service response message","default":"","example":"Gönderilen tutar tüm kırılımların toplam tutarına eşit olmalıdır"},"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system. You need to post it to redirect url when redirection needed","example":"a9bcbe48-0543-4a0d-be41-e423b64a5550"},"redirect_url":{"title":"Redirect Url","type":"string","description":"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","default":"","example":"https://api.jetcheckout.com/api/v1/"},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"Virtual pos name the payment processed","example":"Garanti Sanal Pos"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment processed","example":35},"amount":{"title":"Amount","type":"number","description":"Payment amount","example":12.5},"commission_amount":{"title":"Commission Amount","type":"number","description":"Payment commission amount","example":0.5},"expected_cost_rate":{"title":"Expected Cost Rate","type":"number","description":"Payment expected cost rate","example":0.5},"expected_cost_amount":{"title":"Expected Cost Amount","type":"number","description":"Payment expected cost amount","example":12.5},"currency":{"title":"Currency","type":"string","description":"Payment currency","example":"TRY"},"auth_code":{"title":"Auth Code","type":"string","description":"Bank authorization code","example":"058942"},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment Count","example":"1"},"bin_code":{"title":"Bin Code","type":"string","description":"Card Bin Code","example":"521807"},"card_type":{"title":"Card Type","type":"string","description":"Card Type","example":"Credit"},"card_program":{"title":"Card Program","type":"string","description":"Card Program","example":"Mastercard"},"card_family":{"title":"Card Family","type":"string","description":"Card Family","example":"Axess"},"card_bank_eft_code":{"title":"Card Bank Eft Code","type":"string","description":"Card Bank Eft Code","example":"046"},"card_bank_name":{"title":"Card Bank Name","type":"string","description":"Card Bank Name","example":"Akbank T.A.Ş."}}},"PaymentSimulationRequest":{"title":"PaymentSimulationRequest","required":["application_key","amount","is_3d","hash_data"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","example":"TRY"},"amount":{"title":"Amount","type":"integer","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"installment_count":{"title":"Installment Count","type":"string","description":"Its default is without installment, if you want to make installment please send the installment count as string","example":"1"},"inst_period":{"title":"Inst Period","type":"integer","description":"Its default is 1, please send the installment period if it is different than 1","default":1,"example":1},"card_number":{"title":"Card Number","maxLength":16,"minLength":15,"type":"string","description":"Card number that will use in payment. This data never stores at our database, application logs. It is only directed to payment system.","example":"4508034508034509"},"expire_month":{"title":"Expire Month","maxLength":2,"minLength":1,"pattern":"^[0-9]*$","type":"string","description":"Expire month of the card. Our api acts like card number.","example":"12"},"expire_year":{"title":"Expire Year","maxLength":4,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"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.","example":"2026"},"card_token":{"title":"Card Token","type":"string","description":"Card token that will use in payment.","example":"133356090a864a579a591107cfa08cbd"},"is_3d":{"title":"Is 3D","type":"boolean","description":"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.","example":false},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + CARD_NUMBER + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"customer_id":{"title":"Customer Id","type":"string","description":"Customer id","example":"135"},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Is payment for sub merchant ?","example":true},"is_preauth":{"title":"Is Preauth","type":"boolean","description":"Is payment pre auth?","example":true},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"is_agricultural_payment":{"title":"Is Agricultural Payment","type":"boolean","description":"Is payment for agricultural?","example":true},"agricultural_code":{"title":"Agricultural Code","type":"string","description":"Agricultural payment code. It is required when the payment is agricultural payment","example":"1"}}},"PaymentSimulationResponse":{"title":"PaymentSimulationResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"You will get 00 for successful response, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful Payment"},"is_3d":{"title":"Is 3D","type":"boolean","description":"Specifies the payment will be 3d or none 3d","default":true,"example":true},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"This is the name of virtual pos the payment will be processed","default":"","example":"Garanti Sanal POS"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"This is the name of virtual pos the payment will be processed","default":0,"example":35},"expected_cost_rate":{"title":"Expected Cost Rate","type":"number","description":"Cost rate of payment","default":0,"example":1.12},"expected_cost_amount":{"title":"Expected Cost Amount","type":"number","description":"Cost amount of payment","default":0,"example":11.12},"expected_customer_rate":{"title":"Expected Customer Rate","type":"number","description":"Customer rate of payment","default":0,"example":1.12}}},"PaymentStatusChangeEvent":{"title":"PaymentStatusChangeEvent","required":["transaction_id","order_id","is_success"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"is_success":{"title":"Is Success","type":"boolean","description":"Payment is Successful","example":false}}},"PaymentStatusRequest":{"title":"PaymentStatusRequest","required":["application_key","order_id"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"It must be one the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"lang":{"title":"Lang","type":"string","description":"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.","default":"tr","example":"tr"}}},"PaymentStatusResponse":{"title":"PaymentStatusResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"The status of query operation. 00200 means it is successful, 00404 means no transaction with the queried order_id","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Here is the payment info"},"order_id":{"title":"Order Id","type":"string","description":"The queried order_id","example":"order-hugin-0921341"},"transaction_id":{"title":"Transaction Id","type":"string","description":"Unique id of payment order in our system","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"transaction_date":{"title":"Transaction Date","type":"string","description":"Payment transaction date","example":"2021-12-09 00:13:35"},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"Virtual pos name the payment had been processed","example":"Garanti Sanal Pos"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment had been processed","example":35},"successful":{"title":"Successful","type":"boolean","description":"Describes the payment is successful or not","example":true},"completed":{"title":"Completed","type":"boolean","description":"Describes the payment is completed or not","example":true},"is_3d":{"title":"Is 3D","type":"boolean","description":"Describes the payment is done with 3d secure process","example":true},"amount":{"title":"Amount","type":"number","description":"Payment requested amount","example":12.5},"paid_amount":{"title":"Paid Amount","type":"number","description":"Payment amount","example":12.5},"rem_amount":{"title":"Rem Amount","type":"number","description":"Remaining Payment amount","example":12.5},"commission_amount":{"title":"Commission Amount","type":"number","description":"Payment commission amount","example":0.5},"expected_cost_rate":{"title":"Expected Cost Rate","type":"number","description":"Payment expected cost rate","example":0.5},"expected_cost_amount":{"title":"Expected Cost Amount","type":"number","description":"Payment expected cost amount","example":12.5},"payment_system":{"title":"Payment System","type":"string","description":"Payment System","example":"GARANTI"},"currency":{"title":"Currency","type":"string","description":"Payment currency","example":"TRY"},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment count","default":1,"example":1},"inst_period":{"title":"Inst Period","type":"integer","description":"Installment period","default":1,"example":1},"auth_code":{"title":"Auth Code","type":"string","description":"Bank authorization code","example":"058942"},"service_ref_id":{"title":"Service Ref Id","type":"string","description":"Payment unique reference id on payment organisation","example":"145564688XVT1234"},"cancelled":{"title":"Cancelled","type":"boolean","description":"It is true if the payment cancelled on same day","example":false},"refund_amount":{"title":"Refund Amount","type":"number","description":"Payment refund amount","example":2.7},"bin_code":{"title":"Bin Code","type":"string","description":"Card Bin Code","example":"521807"},"card_type":{"title":"Card Type","type":"string","description":"Card Type","example":"Credit"},"card_program":{"title":"Card Program","type":"string","description":"Card Program","example":"Mastercard"},"card_family":{"title":"Card Family","type":"string","description":"Card Family","example":"Axess"},"card_bank_eft_code":{"title":"Card Bank Eft Code","type":"string","description":"Card Bank Eft Code","example":"046"},"card_bank_name":{"title":"Card Bank Name","type":"string","description":"Card Bank Name","example":"Akbank T.A.Ş."},"pos_bank_eft_code":{"title":"Pos Bank Eft Code","type":"string","description":"Pos Bank Eft Code","example":"15"},"pos_bank_name":{"title":"Pos Bank Name","type":"string","description":"Pos Bank Name","example":"T.VAKIFLAR BANKASI T.A.O."},"error_message":{"title":"Error Message","type":"string","description":"Error message","example":"00"},"payment_response_code":{"title":"Payment Response Code","type":"string","description":"Payment response code","example":"00"},"payment_response_message":{"title":"Payment Response Message","type":"string","description":"Payment response message","example":"00"},"credit_bank":{"title":"Credit Bank","type":"string","description":"Credit Bank EFT Code","example":"00"},"credit_status":{"allOf":[{"$ref":"#/components/schemas/CreditStatusEnum"}],"description":"Credit Status","default":"Unknown","example":"Unknown"},"preauth":{"title":"Preauth","type":"boolean","description":"Payment is pre auth ?","default":false,"example":true},"postauth":{"title":"Postauth","type":"boolean","description":"Pre auth payment is approved ?","default":false,"example":true},"approval_code":{"title":"Approval Code","type":"string","description":"Bank authorization code","example":"021965"},"bank_trace_number":{"title":"Bank Trace Number","type":"string","description":"Bank Trace No","example":"618109934932"},"items":{"title":"Items","type":"array","items":{"$ref":"#/components/schemas/PaymentTransactionItem"}},"refunds":{"title":"Refunds","type":"array","items":{"$ref":"#/components/schemas/PaymentCancelTransaction"}}}},"PaymentTransactionItem":{"title":"PaymentTransactionItem","type":"object","properties":{"id":{"title":"Id","type":"integer","default":0},"transaction_id":{"title":"Transaction Id","type":"integer"},"item_id":{"title":"Item Id","type":"string"},"item_transaction_id":{"title":"Item Transaction Id","type":"string"},"amount":{"title":"Amount","type":"number"},"refund_amount":{"title":"Refund Amount","type":"number"},"submerchant_id":{"title":"Submerchant Id","type":"integer"},"submerchant_external_id":{"title":"Submerchant External Id","type":"string"},"submerchant_amount":{"title":"Submerchant Amount","type":"number"},"submerchant_pay_approved":{"title":"Submerchant Pay Approved","type":"boolean","default":false},"submerchant_key":{"title":"Submerchant Key","type":"string"}}},"PaymentTypeEnum":{"title":"PaymentTypeEnum","enum":["Virtual","Physical","Wallet","WireTransfer","SoftPOS","ShoppingCredit"],"type":"string","description":"An enumeration."},"PaymentTypeRequest":{"title":"PaymentTypeRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"customer_id":{"title":"Customer Id","type":"string","description":"Customer id","example":"135"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"PaymentTypeResponse":{"title":"PaymentTypeResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"payment_types":{"type":"array","items":{"$ref":"#/components/schemas/PaymentTypeEnum"},"description":"Available payment types list","default":[],"example":"['Virtual','Wallet']"}}},"PhysicalDeviceInfo":{"title":"PhysicalDeviceInfo","type":"object","properties":{"device_id":{"title":"Device Id","type":"integer","description":"Physical pos device id in Paylox","example":11},"device_name":{"title":"Device Name","type":"string","description":"Physical pos device name in Paylox","example":"Caddebostan - 3"},"device_fiscal_id":{"title":"Device Fiscal Id","type":"string","description":"Physical pos device number in device owner system","example":"FT30022014"}}},"PhysicalDevicePairRequest":{"title":"PhysicalDevicePairRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"device_id":{"title":"Device Id","type":"string","description":"Device Fiscal Id","example":"N860W676041"},"device_owner":{"title":"Device Owner","type":"string","description":"Device Owner","default":"pavo","example":"pavo"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"PhysicalPairingResponse":{"title":"PhysicalPairingResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful Payment"},"pairing_id":{"title":"Pairing Id","type":"integer","description":"This is the pairing id","example":789},"pairing_code":{"title":"Pairing Code","type":"string","description":"Pairing code, you will use this code on device pairing screen","example":"245186"}}},"PhysicalPaymentCardFamilyRequest":{"title":"PhysicalPaymentCardFamilyRequest","required":["application_key","order_id","amount","store_code","callback_api_url"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"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","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"string","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"store_code":{"title":"Store Code","type":"string","description":"Store Code","example":"M0004"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"card_family_id":{"title":"Card Family Id","type":"integer","description":"Card Family Id","example":"Maximum"},"installment_count":{"title":"Installment Count","type":"integer","description":"Its default is without installment, if you want to make installment please send the installment count","default":1,"example":1},"document_type":{"title":"Document Type","type":"integer","description":"Document Type. Possible values 1:Receipt, 2:Invoice, 3:EInvoice, 4:EArchive, 5:Food, 6:Parking, 7:Prepayment, 8:InvoicePayment, 9:CurrentAccount","default":4,"example":"4"},"callback_api_url":{"title":"Callback Api Url","type":"string","description":"The json result comes from physical device will be posted to this api url.","example":"https://api.jetcheckout.com/api/v1/merchant/success"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"sale_items":{"title":"Sale Items","type":"array","items":{"$ref":"#/components/schemas/SaleItem"},"description":"Content of order."},"pay_items":{"title":"Pay Items","type":"array","items":{"$ref":"#/components/schemas/PayItem"},"description":"Payment items."},"customer_info":{"title":"Customer Info","allOf":[{"$ref":"#/components/schemas/CustomerInfo"}],"description":"Customer info."},"sales_person":{"title":"Sales Person","type":"integer","description":"Sales person","default":0,"example":0}}},"PhysicalPaymentCardFamilyResponse":{"title":"PhysicalPaymentCardFamilyResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful Payment"},"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system. You need to post it to redirect url when redirection needed","example":"a9bcbe48-0543-4a0d-be41-e423b64a5550"},"pos_order_number":{"title":"Pos Order Number","type":"string","description":"Physical pos device order number","example":"102562"},"devices":{"title":"Devices","type":"array","items":{"$ref":"#/components/schemas/PhysicalDeviceInfo"},"description":"Available devices for this payment","example":"[{ 'device_id': 11, 'device_name': 'Caddebostan - 3', 'device_fiscal_id': 'FT30022014' }]"}}},"PhysicalPaymentFinishRequest":{"title":"PhysicalPaymentFinishRequest","required":["application_key","order_id","transaction_id","bank_code"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"Order Id","example":"sa-ss12-211-1111"},"transaction_id":{"title":"Transaction Id","type":"string","description":"Transaction Id","example":"32692f0538404f1eb2fc95d9a7ce3c40"},"bank_code":{"title":"Bank Code","type":"string","description":"Bank EFT Code","example":"0015"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"PhysicalPaymentFinishResponse":{"title":"PhysicalPaymentFinishResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful Payment"}}},"PhysicalPaymentFinished":{"title":"PhysicalPaymentFinished","required":["transaction_id","order_id","virtual_pos_name","virtual_pos_id","is_success","response_code","response_message","physical_order_number","payment_items"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"Virtual pos name the payment had been processed","example":"Hugin Fiziksel Pos"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment had been processed","example":35},"is_success":{"title":"Is Success","type":"boolean","description":"Payment is Successful","example":true},"response_code":{"title":"Response Code","type":"string","description":"Response code","example":"00"},"response_message":{"title":"Response Message","type":"string","description":"Response message","example":"İşlem Başarılı"},"physical_order_number":{"title":"Physical Order Number","type":"string","description":"Physical Device Order Number","example":"104879"},"payment_items":{"title":"Payment Items","type":"array","items":{"$ref":"#/components/schemas/PaymentItem"},"description":"Payment Items"}}},"PhysicalPaymentRequest":{"title":"PhysicalPaymentRequest","required":["application_key","order_id","amount","store_code","callback_api_url"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"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","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"string","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"installment_count":{"title":"Installment Count","type":"integer","description":"Its default is without installment, if you want to make installment please send the installment count","default":1,"example":1},"store_code":{"title":"Store Code","type":"string","description":"Store Code","example":"M0004"},"document_type":{"title":"Document Type","type":"integer","description":"Document Type. Possible values 1:Receipt, 2:Invoice, 3:EInvoice, 4:EArchive, 5:Food, 6:Parking, 7:Prepayment, 8:InvoicePayment, 9:CurrentAccount","default":4,"example":"4"},"callback_api_url":{"title":"Callback Api Url","type":"string","description":"The json result comes from physical device will be posted to this api url.","example":"https://api.jetcheckout.com/api/v1/merchant/success"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"sale_items":{"title":"Sale Items","type":"array","items":{"$ref":"#/components/schemas/SaleItem"},"description":"Content of order."},"device_ids":{"title":"Device Ids","type":"array","items":{"type":"string"},"description":"Device Id","example":"['FT30022014', 'FT30012506']"},"pay_items":{"title":"Pay Items","type":"array","items":{"$ref":"#/components/schemas/PayItem"},"description":"Payment items."},"customer_info":{"title":"Customer Info","allOf":[{"$ref":"#/components/schemas/CustomerInfo"}],"description":"Customer info."},"sales_person":{"title":"Sales Person","type":"integer","description":"Sales person","default":0,"example":0},"device_owner":{"title":"Device Owner","type":"string","default":"hugin","example":"hugin"}}},"PhysicalPaymentResponse":{"title":"PhysicalPaymentResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful Payment"},"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system. You need to post it to redirect url when redirection needed","example":"a9bcbe48-0543-4a0d-be41-e423b64a5550"},"pos_order_number":{"title":"Pos Order Number","type":"string","description":"Physical pos device order number","example":"102562"}}},"PointInfoRequest":{"title":"PointInfoRequest","required":["application_key","card_number","card_holder_name","expire_month","expire_year","cvc","hash_data"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"card_number":{"title":"Card Number","maxLength":16,"minLength":15,"type":"string","description":"Card number that will use in payment. This data never stores at our database, application logs. It is only directed to payment system.","example":"4508034508034509"},"card_holder_name":{"title":"Card Holder Name","type":"string","description":"Cardholder name of the card that will use in payment. Our api acts like card number.","example":"Hasan Akay"},"expire_month":{"title":"Expire Month","maxLength":2,"minLength":1,"pattern":"^[0-9]*$","type":"string","description":"Expire month of the card. Our api acts like card number.","example":"12"},"expire_year":{"title":"Expire Year","maxLength":4,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"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.","example":"2026"},"cvc":{"title":"Cvc","type":"string","description":"Cvc of the card. Our api acts like card number.","example":"000"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + CARD_NUMBER + SECRET_KEY ) )","example":"sadsaas3e412"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"PointInfoResponse":{"title":"PointInfoResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"amount":{"title":"Amount","type":"number","description":"Card usable point amount","default":0,"example":345.45}}},"PosWallet":{"title":"PosWallet","type":"object","properties":{"wallet_id":{"title":"Wallet Id","type":"integer","description":"Wallet Service Wallet Id","example":48},"name":{"title":"Name","type":"string","description":"Wallet Name","example":"Parapara"},"image_url":{"title":"Image Url","type":"string","description":"Wallet Image Url","example":"http://localhost:8069/web/image?model=jet.payment.org&id=1&field=avatar_128"},"description":{"title":"Description","type":"string","description":"Wallet description","example":"parapara ile ödemeler çok kolay"}}},"QueryBinRequest":{"title":"QueryBinRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"amount":{"title":"Amount","type":"integer","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","default":0,"example":1250},"currency":{"title":"Currency","minLength":3,"type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"bin":{"title":"Bin","maxLength":8,"minLength":6,"type":"string","description":"It is first six character of card number that will be use in payment","example":"450803"},"card_token":{"title":"Card Token","type":"string","description":"Card token that will use in payment.","example":"133356090a864a579a591107cfa08cbd"},"store_code":{"title":"Store Code","type":"string","description":"If you are using physical devices you must send store code for installment options on physical devices","default":"","example":"M0001"},"customer_id":{"title":"Customer Id","type":"string","description":"Customer id","default":"","example":"135"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"is_3d":{"title":"Is 3D","type":"boolean","description":"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.","default":true,"example":false},"plus_inst_preferred":{"title":"Plus Inst Preferred","type":"boolean","description":"If there are more than one installment options for the same period, options with plus installment are preferred when this flag is true","default":true,"example":false},"plus_inst_seperated":{"title":"Plus Inst Seperated","type":"boolean","description":"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","default":false,"example":true},"is_submerchant_payment":{"title":"Is Submerchant Payment","type":"boolean","description":"Is payment for sub merchant ?","example":true},"is_preauth":{"title":"Is Preauth","type":"boolean","description":"Is payment pre auth?","example":true},"is_agricultural_payment":{"title":"Is Agricultural Payment","type":"boolean","description":"Is payment for agricultural?","example":true},"agricultural_code":{"title":"Agricultural Code","type":"string","description":"Agricultural payment code. It is required when the payment is agricultural payment","example":"1"}}},"QueryBinResponse":{"title":"QueryBinResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"is_3d":{"title":"Is 3D","type":"boolean","description":"Specifies installment options are available for 3d or none 3d payments","default":true,"example":true},"installments":{"title":"Installments","type":"array","items":{"$ref":"#/components/schemas/BinOption"},"description":"The detailed information about currency and installment count combination that can be used for queried bin","default":[]}}},"RefundRequest":{"title":"RefundRequest","required":["application_key","order_id","transaction_id","amount","currency"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"It must be one the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"transaction_id":{"title":"Transaction Id","type":"string","description":"It must be one the transaction_id's that returned from payment transaction.","example":"8123asd23a45sf1341dasd1"},"amount":{"title":"Amount","type":"string","description":"It is amount to be refunded, for 10.00 send 1000, some payment systems accepts partial refund, some do not.","example":"1000"},"currency":{"title":"Currency","type":"string","description":"It must be same currency as the purchase","example":"TRY"},"ip_address":{"title":"Ip Address","type":"string","description":"IP address of client.","default":"","example":"1.1.111.111"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"ResponseCodeDesc":{"title":"ResponseCodeDesc","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"Response code","default":"","example":"00101"},"description":{"title":"Description","type":"string","description":"Explanation of error","default":"","example":"Belirtilen uygulama anahtarı geçersiz"}}},"ResponseCodeRequest":{"title":"ResponseCodeRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"language":{"title":"Language","type":"string","description":"The language which you want to see the response description","default":"tr","example":"tr"}}},"ResponseCodeResponse":{"title":"ResponseCodeResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"response_codes":{"title":"Response Codes","type":"array","items":{"$ref":"#/components/schemas/ResponseCodeDesc"},"default":[]}}},"SaleItem":{"title":"SaleItem","required":["name","barcode","qty","price","amount","tax_rate"],"type":"object","properties":{"name":{"title":"Name","type":"string","description":"Name of item.","example":"Kalem"},"barcode":{"title":"Barcode","type":"string","description":"Item barcode","example":"250001"},"qty":{"title":"Qty","type":"integer","description":"Quantiy of item","example":2},"price":{"title":"Price","type":"number","description":"Unit price of item","example":5.1},"amount":{"title":"Amount","type":"number","description":"Total amount of item","example":10.2},"tax_rate":{"title":"Tax Rate","type":"integer","description":"Tax rate, acceptable rates are 0, 1, 8 and 18","example":1}}},"SavedCard":{"title":"SavedCard","type":"object","properties":{"id":{"title":"Id","type":"string"},"card_alias":{"title":"Card Alias","type":"string"},"masked_card_number":{"title":"Masked Card Number","type":"string"},"user_id":{"title":"User Id","type":"string"},"card_owner_key":{"title":"Card Owner Key","type":"string"},"card_token":{"title":"Card Token","type":"string"},"card_customer_token":{"title":"Card Customer Token","type":"string"}}},"SavedCardCustomerQueryResponse":{"title":"SavedCardCustomerQueryResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"card_info":{"title":"Card Info","type":"array","items":{"$ref":"#/components/schemas/SavedCard"}}}},"SavedCardQueryRequest":{"title":"SavedCardQueryRequest","required":["application_key","card_owner_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"card_owner_key":{"title":"Card Owner Key","type":"string","description":"Card Unique Id in your system","example":"1231798798"},"language":{"title":"Language","type":"string","description":"The language which you want to see the response description","default":"tr","example":"tr"}}},"SavedCardQueryResponse":{"title":"SavedCardQueryResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"card_info":{"$ref":"#/components/schemas/SavedCard"}}},"SavedCustomerCardQueryRequest":{"title":"SavedCustomerCardQueryRequest","required":["application_key","card_customer_token"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"card_customer_token":{"title":"Card Customer Token","type":"string","description":"Card Customer Token in your system","example":"1231798798"},"language":{"title":"Language","type":"string","description":"The language which you want to see the response description","default":"tr","example":"tr"}}},"ScItemCategory":{"title":"ScItemCategory","type":"object","properties":{"id":{"title":"Id","type":"integer","description":"Item Category Id","default":1,"example":"M0001"},"name":{"title":"Name","type":"string","description":"Item Category Name","default":"","example":"Yapı Malzemeleri"},"description":{"title":"Description","type":"string","description":"Item Category Description","default":"","example":"Yapı Malzemeleri"}}},"ScItemCategoryRequest":{"title":"ScItemCategoryRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"language":{"title":"Language","type":"string","description":"The language which you want to see the response description","default":"tr","example":"tr"}}},"ScItemCategoryResponse":{"title":"ScItemCategoryResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"categories":{"title":"Categories","type":"array","items":{"$ref":"#/components/schemas/ScItemCategory"},"default":[]}}},"ShoppingCreditFinishEvent":{"title":"ShoppingCreditFinishEvent","required":["transaction_id","order_id","response_code","response_message","virtual_pos_name","virtual_pos_id","amount","commission_amount","expected_cost_rate","expected_cost_amount","currency","auth_code","installment_count","hash_data"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"response_code":{"title":"Response Code","type":"string","description":"00 means it is successful, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"response_message":{"title":"Response Message","type":"string","description":"Here is the explanation of response code","example":"Here is the payment info"},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"Virtual pos name the payment had been processed","example":"Garanti Sanal Pos"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment had been processed","example":35},"amount":{"title":"Amount","type":"number","description":"Payment requested amount","example":12.5},"commission_amount":{"title":"Commission Amount","type":"number","description":"Payment commission amount","example":0.5},"expected_cost_rate":{"title":"Expected Cost Rate","type":"number","description":"Payment expected cost rate","example":0.5},"expected_cost_amount":{"title":"Expected Cost Amount","type":"number","description":"Payment expected cost amount","example":12.5},"currency":{"title":"Currency","type":"string","description":"Payment currency","example":"TRY"},"auth_code":{"title":"Auth Code","type":"string","description":"Bank authorization code","example":"058942"},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment Count","example":"1"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the hash data for check. BASE_64_ENCODE( SHA_256( order_id + response_code + application_secret_key ) )","example":"sadsaas3e412"}}},"ShoppingCreditOption":{"title":"ShoppingCreditOption","type":"object","properties":{"bank_code":{"title":"Bank Code","type":"string","description":"Bank EFT Code","default":"","example":"034"},"bank_name":{"title":"Bank Name","type":"string","description":"Bank Name","default":"","example":"Ziraat Bankası"},"bank_credit_desc":{"title":"Bank Credit Desc","type":"string","description":"Bank Credit Description","default":"","example":"Ziraat Bankası"},"bank_logo":{"title":"Bank Logo","type":"string","description":"Bank Logo","default":"","example":"http://app.jetchekout.com/web/image?model=jet.bank&id=2&field=avatar_128"},"bank_supports_new_customer":{"title":"Bank Supports New Customer","type":"boolean","description":"Bank accepts new customers for credit","default":false,"example":false},"currency":{"title":"Currency","type":"string","description":"Currency","default":"","example":"TRY"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"installments":{"title":"Installments","type":"array","items":{"$ref":"#/components/schemas/models__shopping_credit_option_response__Installment"},"description":"The detailed information about possible installment options","default":[]}}},"ShoppingCreditOptionRequest":{"title":"ShoppingCreditOptionRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"amount":{"title":"Amount","type":"integer","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","default":0,"example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"ShoppingCreditOptionResponse":{"title":"ShoppingCreditOptionResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"installment_options":{"title":"Installment Options","type":"array","items":{"$ref":"#/components/schemas/ShoppingCreditOption"},"default":[]}}},"ShoppingCreditPreApprovedRequest":{"title":"ShoppingCreditPreApprovedRequest","required":["application_key","order_id","amount","basket_items","customer"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"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","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"number","description":"Total amount","example":1250.42},"basket_items":{"title":"Basket Items","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/models__shopping_credit_pre_approved_request__ShoppingCreditBasketItem"},"description":"Content of order. Our api acts like card number."},"customer":{"title":"Customer","allOf":[{"$ref":"#/components/schemas/models__shopping_credit_pre_approved_request__ShoppingCreditCustomer"}],"description":"Customer information. Our api acts like card number."},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"}}},"ShoppingCreditPreApprovedResponse":{"title":"ShoppingCreditPreApprovedResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"banks":{"title":"Banks","type":"array","items":{"$ref":"#/components/schemas/Bank"}}}},"ShoppingCreditRequest":{"title":"ShoppingCreditRequest","required":["application_key","order_id","amount","bank_code","hash_data","success_url","fail_url","customer","basket_items"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"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","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"number","description":"Total amount","example":1250.42},"shippingPrice":{"title":"Shippingprice","type":"number","description":"Shipping price","default":0,"example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"bank_code":{"title":"Bank Code","type":"string","description":"Bank EFT Code","example":"034"},"installment_count":{"title":"Installment Count","type":"integer","description":"Its default is without installment, if you want to make installment please send the installment count as string","default":1,"example":1},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + ORDER_ID + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"success_url":{"title":"Success Url","type":"string","description":"If process result is success it will be posted this url with your order_id.","example":"https://api.jetcheckout.com/api/v1/merchant/success"},"fail_url":{"title":"Fail Url","type":"string","description":"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.","example":"https://api.jetcheckout.com/api/v1/merchant/fail"},"callback_api_url":{"title":"Callback Api Url","type":"string","description":"This is the url address for Shopping Credit Status Changed Event","example":"https://api.jetcheckout.com/api/v1/merchant/success"},"customer":{"title":"Customer","allOf":[{"$ref":"#/components/schemas/models__payment_request__ShoppingCreditCustomer"}],"description":"Customer information. Our api acts like card number."},"basket_items":{"title":"Basket Items","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/models__payment_request__ShoppingCreditBasketItem"},"description":"Content of order. Our api acts like card number."},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"session_id":{"title":"Session Id","type":"string","description":"The sessionId value found in the Bank Payment Table service response is expected to be sent.","default":"","example":"c644902d-1254-43cc-9b70-58b357dbe5eb"},"pre_approved_id":{"title":"Pre Approved Id","type":"string","description":"Application number returned in pre-approval","default":"","example":"c644902d-1254-43cc-9b70-58b357dbe5eb"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"string","description":"Virtual Pos Id","default":"","example":"c644902d-1254-43cc-9b70-58b357dbe5eb"}}},"ShoppingCreditResponse":{"title":"ShoppingCreditResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string"},"message":{"title":"Message","type":"string"},"suggestion":{"title":"Suggestion","type":"string","default":""},"service_resp_code":{"title":"Service Resp Code","type":"string","default":""},"service_resp_message":{"title":"Service Resp Message","type":"string","default":""},"transaction_id":{"title":"Transaction Id","type":"string"},"redirect_url":{"title":"Redirect Url","type":"string"},"service_messages":{"title":"Service Messages","type":"array","items":{"type":"string"}}}},"ShoppingCreditStatusChangeEvent":{"title":"ShoppingCreditStatusChangeEvent","required":["transaction_id","order_id","credit_status"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"credit_status":{"allOf":[{"$ref":"#/components/schemas/CreditStatusEnum"}],"description":"Credit Status","example":"Unknown"}}},"ShoppingCreditSuccessChangeEvent":{"title":"ShoppingCreditSuccessChangeEvent","required":["transaction_id","order_id","is_success"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"is_success":{"title":"Is Success","type":"boolean","description":"Is Success","example":true}}},"SoftPOSCardOption":{"title":"SoftPOSCardOption","type":"object","properties":{"card_family_id":{"title":"Card Family Id","type":"integer","description":"Card Family Id","default":0,"example":5},"card_family":{"title":"Card Family","type":"string","description":"Card Family Name","default":"","example":"Bonus"},"card_family_logo":{"title":"Card Family Logo","type":"string","description":"Card Family Logo","default":"","example":"Bonus"},"card_type":{"allOf":[{"$ref":"#/components/schemas/models__payment_option_response__CardTypeEnum"}],"description":"Card Type","default":"Credit","example":"Credit"},"card_banks":{"title":"Card Banks","type":"array","items":{"$ref":"#/components/schemas/CardBank"},"description":"Card Banks","default":[]},"currency":{"title":"Currency","type":"string","description":"Currency","default":"","example":"TRY"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"excluded_bins":{"title":"Excluded Bins","type":"array","items":{"type":"string"},"description":"This installment count are not available for these bin codes","default":[],"example":"[\"450803\", \"375622\"]"},"installments":{"title":"Installments","type":"array","items":{"$ref":"#/components/schemas/models__payment_option_response__Installment"},"description":"The detailed information about possible installment options","default":[]},"bank_ids":{"title":"Bank Ids","type":"array","items":{"type":"integer"}}}},"SoftPOSFinishEvent":{"title":"SoftPOSFinishEvent","required":["transaction_id","order_id","response_code","response_message","virtual_pos_name","virtual_pos_id","amount","commission_amount","expected_cost_rate","expected_cost_amount","currency","auth_code","installment_count","hash_data"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"response_code":{"title":"Response Code","type":"string","description":"00 means it is successful, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"response_message":{"title":"Response Message","type":"string","description":"Here is the explanation of response code","example":"Here is the payment info"},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"Virtual pos name the payment had been processed","example":"Garanti Sanal Pos"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment had been processed","example":35},"amount":{"title":"Amount","type":"number","description":"Payment requested amount","example":12.5},"commission_amount":{"title":"Commission Amount","type":"number","description":"Payment commission amount","example":0.5},"expected_cost_rate":{"title":"Expected Cost Rate","type":"number","description":"Payment expected cost rate","example":0.5},"expected_cost_amount":{"title":"Expected Cost Amount","type":"number","description":"Payment expected cost amount","example":12.5},"currency":{"title":"Currency","type":"string","description":"Payment currency","example":"TRY"},"auth_code":{"title":"Auth Code","type":"string","description":"Bank authorization code","example":"058942"},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment Count","example":"1"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the hash data for check. BASE_64_ENCODE( SHA_256( order_id + response_code + application_secret_key ) )","example":"sadsaas3e412"}}},"SoftPOSOptionRequest":{"title":"SoftPOSOptionRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"amount":{"title":"Amount","type":"integer","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","default":0,"example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"campaign_name":{"title":"Campaign Name","type":"string","description":"It is the name of pos campaign you defined in our environment","default":"","example":"KAMPANYA"},"card_type":{"allOf":[{"$ref":"#/components/schemas/models__payment_option_response__CardTypeEnum"}],"description":"Card Type","default":"AllTypes","example":"Credit"},"plus_inst_preferred":{"title":"Plus Inst Preferred","type":"boolean","description":"If there are more than one installment options for the same period, options with plus installment are preferred when this flag is true","default":true,"example":false},"plus_inst_seperated":{"title":"Plus Inst Seperated","type":"boolean","description":"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","default":false,"example":true},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"SoftPOSOptionResponse":{"title":"SoftPOSOptionResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"installment_options":{"title":"Installment Options","type":"array","items":{"$ref":"#/components/schemas/SoftPOSCardOption"},"default":[]}}},"SoftPOSRequest":{"title":"SoftPOSRequest","required":["application_key","order_id","amount","hash_data","success_url","fail_url"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"user_email":{"title":"User Email","type":"string","description":"User Email it is required for iyzico Cep POS v2 integration","default":"","example":"kullanici1@iyzico.com"},"order_id":{"title":"Order Id","type":"string","description":"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","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"string","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"card_family_id":{"title":"Card Family Id","type":"integer","description":"Card Family Id","example":"Maximum"},"installment_count":{"title":"Installment Count","type":"integer","description":"Its default is without installment, if you want to make installment please send the installment count as string","default":1,"example":1},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + ORDER_ID + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"success_url":{"title":"Success Url","type":"string","description":"If process result is success it will be posted this url with your order_id.","example":"https://api.jetcheckout.com/api/v1/merchant/success"},"fail_url":{"title":"Fail Url","type":"string","description":"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.","example":"https://api.jetcheckout.com/api/v1/merchant/fail"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"customer":{"title":"Customer","allOf":[{"$ref":"#/components/schemas/Customer"}],"description":"Customer information. Our api acts like card number."},"customer_basket":{"title":"Customer Basket","type":"array","items":{"$ref":"#/components/schemas/BasketItem"},"description":"Content of order. Our api acts like card number."},"billing_address":{"title":"Billing Address","allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Billing address. Our api acts like card number."},"shipping_address":{"title":"Shipping Address","allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Shipping address. Our api acts like card number."},"v2_active":{"title":"V2 Active","type":"boolean","description":"Send True if you want to use iyzico SoftPOS version 2","default":false}}},"SoftPOSResponse":{"title":"SoftPOSResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string"},"message":{"title":"Message","type":"string"},"suggestion":{"title":"Suggestion","type":"string","default":""},"service_resp_code":{"title":"Service Resp Code","type":"string","default":""},"service_resp_message":{"title":"Service Resp Message","type":"string","default":""},"transaction_id":{"title":"Transaction Id","type":"string"},"redirect_url":{"title":"Redirect Url","type":"string"}}},"SoftPOSStatusChangeEvent":{"title":"SoftPOSStatusChangeEvent","required":["transaction_id","order_id","is_success"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"is_success":{"title":"Is Success","type":"boolean","description":"Payment is Successful","example":false}}},"SoftPosUserListRequest":{"title":"SoftPosUserListRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"lang":{"title":"Lang","type":"string","description":"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.","default":"tr","example":"tr"}}},"SoftPosUserListResponse":{"title":"SoftPosUserListResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string"},"message":{"title":"Message","type":"string"},"service_resp_code":{"title":"Service Resp Code","type":"string","default":""},"service_resp_message":{"title":"Service Resp Message","type":"string","default":""},"user_info_list":{"title":"User Info List","type":"array","items":{"$ref":"#/components/schemas/UserInfo"},"default":[]}}},"Store":{"title":"Store","type":"object","properties":{"code":{"title":"Code","type":"string","description":"Store Code","default":"","example":"M0001"},"name":{"title":"Name","type":"string","description":"Store Name","default":"","example":"Caddebostan"}}},"StoreDevice":{"title":"StoreDevice","type":"object","properties":{"id":{"title":"Id","type":"integer","description":"Physical POS Device Id","default":0,"example":5},"fiscal_id":{"title":"Fiscal Id","type":"string","description":"Physical POS Device Fiscal Id","default":"","example":"FT30022014"},"name":{"title":"Name","type":"string","description":"Store Name","default":"","example":"Caddebostan - 2"},"is_active":{"title":"Is Active","type":"boolean","description":"Is Physical POS Device Active","default":false,"example":true},"device_owner":{"title":"Device Owner","type":"string","description":"Physical POS Device Owner","default":"","example":"Pavo"}}},"StoreDeviceRequest":{"title":"StoreDeviceRequest","required":["application_key","store_code"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"store_code":{"title":"Store Code","type":"string","description":"Store Code","example":"M0001"},"language":{"title":"Language","type":"string","description":"The language which you want to see the response description","default":"tr","example":"tr"}}},"StoreDeviceResponse":{"title":"StoreDeviceResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"devices":{"title":"Devices","type":"array","items":{"$ref":"#/components/schemas/StoreDevice"},"default":[]}}},"StoreDeviceUpdateRequest":{"title":"StoreDeviceUpdateRequest","required":["application_key","store_code","device_id","is_active"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"store_code":{"title":"Store Code","type":"string","description":"Store Code","example":"M0001"},"device_id":{"title":"Device Id","type":"integer","description":"Physical POS Device unique id","example":5},"is_active":{"title":"Is Active","type":"boolean","description":"Is Physical POS Device Active","example":false},"language":{"title":"Language","type":"string","description":"The language which you want to see the response description","default":"tr","example":"tr"}}},"StoreDeviceUpdateResponse":{"title":"StoreDeviceUpdateResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"device":{"title":"Device","allOf":[{"$ref":"#/components/schemas/StoreDevice"}],"default":[]}}},"StoreRequest":{"title":"StoreRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"language":{"title":"Language","type":"string","description":"The language which you want to see the response description","default":"tr","example":"tr"}}},"StoreResponse":{"title":"StoreResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"stores":{"title":"Stores","type":"array","items":{"$ref":"#/components/schemas/Store"},"default":[]}}},"StoredCard":{"title":"StoredCard","type":"object","properties":{"card_alias":{"title":"Card Alias","type":"string"},"masked_card_number":{"title":"Masked Card Number","type":"string"},"card_token":{"title":"Card Token","type":"string"},"card_owner_key":{"title":"Card Owner Key","type":"string"}}},"SubMerchant":{"title":"SubMerchant","type":"object","properties":{"submerchant_id":{"title":"Submerchant Id","type":"string"},"external_id":{"title":"External Id","type":"string"},"merchant_name":{"title":"Merchant Name","type":"string"},"name":{"title":"Name","type":"string"},"type":{"$ref":"#/components/schemas/SubMerchantTypeEnum"},"currency":{"title":"Currency","type":"string"},"tax_number":{"title":"Tax Number","type":"string"},"tax_office":{"title":"Tax Office","type":"string"},"title":{"title":"Title","type":"string"},"email":{"title":"Email","type":"string"},"gsm_number":{"title":"Gsm Number","type":"string"},"contact_name":{"title":"Contact Name","type":"string"},"contact_surname":{"title":"Contact Surname","type":"string"},"iban":{"title":"Iban","type":"string"},"address":{"title":"Address","type":"string"},"city":{"title":"City","type":"string"},"payment_due_day":{"title":"Payment Due Day","type":"integer"}}},"SubMerchantCreateRequest":{"title":"SubMerchantCreateRequest","required":["application_key","external_id","type","tax_number","email","iban","address","merchant_name"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"external_id":{"title":"External Id","type":"string","description":"Unique id of sub merchant in your system","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"name":{"title":"Name","type":"string","description":"Name of sub merchant","default":"","example":"Ahmet Solak"},"type":{"allOf":[{"$ref":"#/components/schemas/SubMerchantTypeEnum"}],"description":"Sub Merchant Type","example":"Individual"},"currency":{"title":"Currency","type":"string","description":"Transfer currency, its default is TRY","default":"TRY","example":"TRY"},"tax_number":{"title":"Tax Number","maxLength":11,"minLength":10,"type":"string","description":"Identity number for individuals, tax number for companies","example":"23214999830"},"tax_office":{"title":"Tax Office","type":"string","description":"Tax office of sub merchant.","default":"","example":"Beyoğlu"},"title":{"title":"Title","type":"string","description":"Title of sub merchant.","default":"","example":"Hasan Lojistik A.Ş."},"gsm_number":{"title":"Gsm Number","type":"string","description":"GSM number of sub merchant.","default":"","example":"5304508980"},"email":{"title":"Email","minLength":5,"type":"string","description":"Email address of sub merchant.","example":"ahmetsolak@sample.com"},"contact_name":{"title":"Contact Name","type":"string","description":"It is required for individuals.","default":"","example":"Ahmet"},"contact_surname":{"title":"Contact Surname","type":"string","description":"It is required for individuals.","default":"","example":"Solak"},"iban":{"title":"Iban","type":"string","description":"IBAN of submerchant. For individuals it must be suitable with contact name and contact surname. For companies it must be suitable with title.","example":"TR920023000010112245924502"},"address":{"title":"Address","minLength":5,"type":"string","description":"Address of sub merchant","example":"Altıntepe Mah Bağdat Cad No:34 Maltepe/İstanbul"},"merchant_name":{"title":"Merchant Name","maxLength":50,"minLength":3,"type":"string","description":"Settlement description template","example":"KESKINOGLU"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"city":{"title":"City","maxLength":3,"minLength":2,"type":"string","description":"City Plate Code","default":"34","example":"34"},"payment_due_day":{"title":"Payment Due Day","type":"integer","description":"Payment due day","default":1,"example":1}}},"SubMerchantExternalInfo":{"title":"SubMerchantExternalInfo","type":"object","properties":{"payment_org":{"title":"Payment Org","type":"string"},"external_status":{"$ref":"#/components/schemas/SubmerchantExternalStatusEnum"}}},"SubMerchantPaymentApproveRequest":{"title":"SubMerchantPaymentApproveRequest","required":["application_key","transaction_id"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"transaction_id":{"title":"Transaction Id","type":"string","description":"It must be one the transaction_id's that returned from payment transaction.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"item_id":{"title":"Item Id","type":"string","description":"It must be one the item id's of the related payment transaction.","default":"","example":"item-0001"},"seller_payment_day":{"title":"Seller Payment Day","type":"integer","description":"Seller Payment Day","default":1,"example":1},"lang":{"title":"Lang","type":"string","description":"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.","default":"tr","example":"tr"}}},"SubMerchantPaymentApproveResponse":{"title":"SubMerchantPaymentApproveResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"You will get 00 for successful response, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successful"},"items":{"title":"Items","type":"string","description":"Item list (JSON string)","default":"[]"}}},"SubMerchantQueryRequest":{"title":"SubMerchantQueryRequest","required":["application_key","external_id"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"external_id":{"title":"External Id","type":"string","description":"Unique id of sub merchant in your system","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"SubMerchantResponse":{"title":"SubMerchantResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string"},"message":{"title":"Message","type":"string"},"submerchant_id":{"title":"Submerchant Id","type":"string"},"detail":{"$ref":"#/components/schemas/SubMerchant"},"externals":{"title":"Externals","type":"array","items":{"$ref":"#/components/schemas/SubMerchantExternalInfo"}},"service_error_code":{"title":"Service Error Code","type":"string"},"service_error_message":{"title":"Service Error Message","type":"string"}}},"SubMerchantTypeEnum":{"title":"SubMerchantTypeEnum","enum":["Individual","PersonalCompany","Company"],"type":"string","description":"An enumeration."},"SubMerchantUpdateRequest":{"title":"SubMerchantUpdateRequest","required":["application_key","external_id","type","tax_number","email","iban","address","merchant_name"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"external_id":{"title":"External Id","type":"string","description":"Unique id of sub merchant in your system","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"name":{"title":"Name","type":"string","description":"Name of sub merchant","default":"","example":"Ahmet Solak"},"type":{"allOf":[{"$ref":"#/components/schemas/SubMerchantTypeEnum"}],"description":"Sub Merchant Type","example":"Individual"},"currency":{"title":"Currency","type":"string","description":"Transfer currency, its default is TRY","default":"TRY","example":"TRY"},"tax_number":{"title":"Tax Number","type":"string","description":"Identity number for individuals, tax number for companies","example":"23214999830"},"tax_office":{"title":"Tax Office","type":"string","description":"Tax office of sub merchant.","default":"","example":"Beyoğlu"},"title":{"title":"Title","type":"string","description":"Title of sub merchant.","default":"","example":"Hasan Lojistik A.Ş."},"gsm_number":{"title":"Gsm Number","type":"string","description":"GSM number of sub merchant.","default":"","example":"5304508980"},"email":{"title":"Email","minLength":5,"type":"string","description":"Email address of sub merchant.","example":"ahmetsolak@sample.com"},"contact_name":{"title":"Contact Name","type":"string","description":"It is required for individuals.","default":"","example":"Ahmet"},"contact_surname":{"title":"Contact Surname","type":"string","description":"It is required for individuals.","default":"","example":"Solak"},"iban":{"title":"Iban","type":"string","description":"IBAN of submerchant. For individuals it must be suitable with contact name and contact surname. For companies it must be suitable with title.","example":"TR920023000010112245924502"},"address":{"title":"Address","minLength":5,"type":"string","description":"Address of sub merchant","example":"Altıntepe Mah Bağdat Cad No:34 Maltepe/İstanbul"},"merchant_name":{"title":"Merchant Name","maxLength":50,"minLength":3,"type":"string","description":"Settlement description template","example":"KESKINOGLU"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"city":{"title":"City","maxLength":3,"minLength":2,"type":"string","description":"City Plate Code","default":"34","example":"34"},"payment_due_day":{"title":"Payment Due Day","type":"integer","description":"Payment due day","default":1,"example":1}}},"SubmerchantExternalStatusEnum":{"title":"SubmerchantExternalStatusEnum","enum":["Active","Waiting","Cancelled"],"type":"string","description":"An enumeration."},"UserInfo":{"title":"UserInfo","type":"object","properties":{"email":{"title":"Email","type":"string"},"can_perform_action":{"title":"Can Perform Action","type":"boolean"}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}},"WalletEntegrator":{"title":"WalletEntegrator","type":"object","properties":{"service_name":{"title":"Service Name","type":"string","description":"Wallet service name.","example":"iyzico"},"wallets":{"title":"Wallets","type":"array","items":{"$ref":"#/components/schemas/PosWallet"},"default":[]}}},"WalletLoadRequest":{"title":"WalletLoadRequest","required":["application_key","request_id","channel_id","store_id","phone_number","barcode","description","hash_data","amount"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"request_id":{"title":"Request Id","minLength":5,"type":"string","description":"It must be one the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"channel_id":{"title":"Channel Id","minLength":1,"type":"string","description":"Channel Id","example":"1111"},"store_id":{"title":"Store Id","minLength":1,"type":"string","description":"Store Id","example":"1111"},"phone_number":{"title":"Phone Number","type":"string","description":"Card Phone Number","example":"00905531139786"},"barcode":{"title":"Barcode","type":"string","description":"Card Barcode","example":"1673609266"},"description":{"title":"Description","minLength":5,"type":"string","description":"Description","example":"pratikislem"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + PHONE_NUMBER + BARCODE + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"amount":{"title":"Amount","type":"string","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"WalletLoadResponse":{"title":"WalletLoadResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"You will get 00 for successful cancel/refund operation, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","example":"Successfully Cancelled"}}},"WalletOptionRequest":{"title":"WalletOptionRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"WalletOptionResponse":{"title":"WalletOptionResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"services":{"title":"Services","type":"array","items":{"$ref":"#/components/schemas/WalletEntegrator"},"default":[]}}},"WalletPayFinishEvent":{"title":"WalletPayFinishEvent","required":["transaction_id","order_id","response_code","response_message","virtual_pos_name","virtual_pos_id","amount","commission_amount","expected_cost_rate","currency","auth_code","installment_count","hash_data"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"response_code":{"title":"Response Code","type":"string","description":"00 means it is successful, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"response_message":{"title":"Response Message","type":"string","description":"Here is the explanation of response code","example":"Here is the payment info"},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"Virtual pos name the payment had been processed","example":"Garanti Sanal Pos"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment had been processed","example":35},"amount":{"title":"Amount","type":"number","description":"Payment requested amount","example":12.5},"commission_amount":{"title":"Commission Amount","type":"number","description":"Payment commission amount","example":0.5},"expected_cost_rate":{"title":"Expected Cost Rate","type":"number","description":"Payment expected cost rate","example":0.5},"currency":{"title":"Currency","type":"string","description":"Payment currency","example":"TRY"},"auth_code":{"title":"Auth Code","type":"string","description":"Bank authorization code","example":"058942"},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment Count","example":"1"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the hash data for check. BASE_64_ENCODE( SHA_256( order_id + response_code + application_secret_key ) )","example":"sadsaas3e412"}}},"WalletPayRequest":{"title":"WalletPayRequest","required":["application_key","order_id","amount","service","wallet_id","hash_data","success_url","fail_url"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"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","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"string","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"service":{"title":"Service","type":"string","description":"Wallet Service Provider name must be sent","example":"iyzico"},"wallet_id":{"title":"Wallet Id","type":"integer","description":"Wallet Service Provider wallet id must be sent","example":1},"installment_count":{"title":"Installment Count","type":"string","description":"Its default is without installment, if you want to make installment please send the installment count as string. This info sends to payment services which supports installment count feature.","example":"1"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + ORDER_ID + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"success_url":{"title":"Success Url","type":"string","description":"If process result is success it will be posted this url with your order_id.","example":"https://api.jetcheckout.com/api/v1/merchant/success"},"fail_url":{"title":"Fail Url","type":"string","description":"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.","example":"https://api.jetcheckout.com/api/v1/merchant/fail"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"customer":{"title":"Customer","allOf":[{"$ref":"#/components/schemas/Customer"}],"description":"Customer information. Our api acts like card number."},"customer_basket":{"title":"Customer Basket","type":"array","items":{"$ref":"#/components/schemas/BasketItem"},"description":"Content of order. Our api acts like card number."},"billing_address":{"title":"Billing Address","allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Billing address. Our api acts like card number."},"shipping_address":{"title":"Shipping Address","allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Shipping address. Our api acts like card number."}}},"WalletPayResponse":{"title":"WalletPayResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string"},"message":{"title":"Message","type":"string"},"suggestion":{"title":"Suggestion","type":"string","default":""},"service_resp_code":{"title":"Service Resp Code","type":"string","default":""},"service_resp_message":{"title":"Service Resp Message","type":"string","default":""},"transaction_id":{"title":"Transaction Id","type":"string"},"redirect_url":{"title":"Redirect Url","type":"string"},"qr":{"title":"Qr","type":"string"}}},"WalletPayStatusChangeEvent":{"title":"WalletPayStatusChangeEvent","required":["transaction_id","order_id","is_success"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"is_success":{"title":"Is Success","type":"boolean","description":"Payment is Successful","example":false}}},"WireTransferEntegrator":{"title":"WireTransferEntegrator","type":"object","properties":{"name":{"title":"Name","type":"string","description":"Wire Transfer service name.","example":"iyzico"},"logo_url":{"title":"Logo Url","type":"string","description":"Wire Transfer service provider logo url.","example":"iyzico"}}},"WireTransferFinishEvent":{"title":"WireTransferFinishEvent","required":["transaction_id","order_id","response_code","response_message","virtual_pos_name","virtual_pos_id","amount","commission_amount","expected_cost_rate","expected_cost_amount","currency","auth_code","installment_count","hash_data"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"response_code":{"title":"Response Code","type":"string","description":"00 means it is successful, 00333 means waiting for customer transfer, otherwise another response code for the error. You can reach the list of response codes on the Response Codes Api","example":"00"},"response_message":{"title":"Response Message","type":"string","description":"Here is the explanation of response code","example":"Here is the payment info"},"virtual_pos_name":{"title":"Virtual Pos Name","type":"string","description":"Virtual pos name the payment had been processed","example":"Garanti Sanal Pos"},"virtual_pos_id":{"title":"Virtual Pos Id","type":"integer","description":"Virtual pos id the payment had been processed","example":35},"amount":{"title":"Amount","type":"number","description":"Payment requested amount","example":12.5},"commission_amount":{"title":"Commission Amount","type":"number","description":"Payment commission amount","example":0.5},"expected_cost_rate":{"title":"Expected Cost Rate","type":"number","description":"Payment expected cost rate","example":0.5},"expected_cost_amount":{"title":"Expected Cost Amount","type":"number","description":"Payment expected cost amount","example":12.5},"currency":{"title":"Currency","type":"string","description":"Payment currency","example":"TRY"},"auth_code":{"title":"Auth Code","type":"string","description":"Bank authorization code","example":"058942"},"installment_count":{"title":"Installment Count","type":"integer","description":"Installment Count","example":"1"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the hash data for check. BASE_64_ENCODE( SHA_256( order_id + response_code + application_secret_key ) )","example":"sadsaas3e412"}}},"WireTransferOptionRequest":{"title":"WireTransferOptionRequest","required":["application_key"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"}}},"WireTransferOptionResponse":{"title":"WireTransferOptionResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string","description":"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","default":"","example":"00"},"message":{"title":"Message","type":"string","description":"Here is the explanation of response code","default":"","example":"Successful"},"services":{"title":"Services","type":"array","items":{"$ref":"#/components/schemas/WireTransferEntegrator"},"default":[]}}},"WireTransferRequest":{"title":"WireTransferRequest","required":["application_key","order_id","amount","service","hash_data","success_url","fail_url"],"type":"object","properties":{"application_key":{"title":"Application Key","type":"string","description":"It is the key of your application on our environment","example":"6e3cdaa3-65df-4eff-aed2-9d74387701dd"},"order_id":{"title":"Order Id","type":"string","description":"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","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"amount":{"title":"Amount","type":"string","description":"It must be send in integer format by multipliying original value with 100. For example 1 must be 100, 3.42 must be 342","example":1250},"currency":{"title":"Currency","type":"string","description":"Its default is TRY, if you want to use another currency please send it by ISO Code like USD, EUR","default":"TRY","example":"TRY"},"service":{"title":"Service","type":"string","description":"Wire Transfer Service Provider name must be sent","example":"iyzico"},"hash_data":{"title":"Hash Data","type":"string","description":"This is the calculated hash data for this sample payment request. BASE_64_ENCODE( SHA_256( APPLICATION_KEY + ORDER_ID + AMOUNT + SECRET_KEY ) )","example":"sadsaas3e412"},"success_url":{"title":"Success Url","type":"string","description":"If process result is success it will be posted this url with your order_id. This process is waiting for customer payment you need to check response_code and also you can use query status api for the result check.","example":"https://api.jetcheckout.com/api/v1/merchant/success"},"fail_url":{"title":"Fail Url","type":"string","description":"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.","example":"https://api.jetcheckout.com/api/v1/merchant/fail"},"mode":{"title":"Mode","type":"string","description":"Please send it as 'T' for test purposes, otherwise it will be in production mode.","default":"P","example":"T"},"language":{"title":"Language","type":"string","description":"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.","default":"tr","example":"tr"},"customer":{"title":"Customer","allOf":[{"$ref":"#/components/schemas/Customer"}],"description":"Customer information. Our api acts like card number."},"customer_basket":{"title":"Customer Basket","type":"array","items":{"$ref":"#/components/schemas/BasketItem"},"description":"Content of order. Our api acts like card number."},"billing_address":{"title":"Billing Address","allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Billing address. Our api acts like card number."},"shipping_address":{"title":"Shipping Address","allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Shipping address. Our api acts like card number."}}},"WireTransferResponse":{"title":"WireTransferResponse","type":"object","properties":{"response_code":{"title":"Response Code","type":"string"},"message":{"title":"Message","type":"string"},"suggestion":{"title":"Suggestion","type":"string","default":""},"service_resp_code":{"title":"Service Resp Code","type":"string","default":""},"service_resp_message":{"title":"Service Resp Message","type":"string","default":""},"transaction_id":{"title":"Transaction Id","type":"string"},"redirect_url":{"title":"Redirect Url","type":"string"}}},"WireTransferStatusChangeEvent":{"title":"WireTransferStatusChangeEvent","required":["transaction_id","order_id","is_success"],"type":"object","properties":{"transaction_id":{"title":"Transaction Id","type":"string","description":"This is the unique id of your payment request in our system","example":"a38d0de6f8a34508ae2461c926507dbf"},"order_id":{"title":"Order Id","type":"string","description":"It is one of the order_id's that you send to payment request previously.","example":"9ee3fd53-42f9-4f16-b454-77e6b714c2e9"},"is_success":{"title":"Is Success","type":"boolean","description":"Payment is Successful","example":false}}},"models__payment_option_response__CardTypeEnum":{"title":"CardTypeEnum","enum":["AllTypes","Debit","Credit","Credit-Business"],"type":"string","description":"An enumeration."},"models__payment_option_response__Installment":{"title":"Installment","type":"object","properties":{"installment_count":{"title":"Installment Count","type":"integer","description":"Installment Count","default":1,"example":"7"},"installment_amount":{"title":"Installment Amount","type":"number","description":"Installment Amount","default":0,"example":1.12},"cost_rate":{"title":"Cost Rate","type":"number","description":"Cost rate of this installment count","default":0,"example":1.12},"customer_rate":{"title":"Customer Rate","type":"number","description":"Customer rate of this installment count","default":0,"example":1.35},"additional_rate":{"title":"Additional Rate","type":"number","description":"Funding rate of this installment count","default":0,"example":1.35},"margin_rate":{"title":"Margin Rate","type":"number","description":"Margin rate of this installment count","default":0,"example":1.35},"min_customer_rate":{"title":"Min Customer Rate","type":"number","description":"Minimum customer rate of this installment count","default":0,"example":1.35},"max_customer_rate":{"title":"Max Customer Rate","type":"number","description":"Maximum customer rate of this installment count","default":0,"example":1.35},"plus_installment":{"title":"Plus Installment","type":"integer","description":"Plus installment count that can be used","default":0,"example":2},"plus_installment_description":{"title":"Plus Installment Description","type":"string","description":"Plus installment description","default":"","example":"You can add 2 installment at electronic devices sales"},"min_amount":{"title":"Min Amount","type":"integer","description":"This option can bu used with mininum this amount. If it is zero there is no limitations","default":0,"example":2},"max_amount":{"title":"Max Amount","type":"integer","description":"This option can bu used with maximum this amount. If it is zero there is no limitations","default":0,"example":2}}},"models__payment_option_response__PosDevice":{"title":"PosDevice","type":"object","properties":{"id":{"title":"Id","type":"integer","description":"Physical POS Device Id","default":0,"example":"5"},"name":{"title":"Name","type":"string","description":"Physical POS Device Name","default":"","example":"POS - 2"}}},"models__payment_request__ShoppingCreditBasketItem":{"title":"ShoppingCreditBasketItem","required":["id","name","brandName","qty","unitPrice","category"],"type":"object","properties":{"id":{"title":"Id","minLength":1,"type":"string","description":"Item id","example":"KL015"},"name":{"title":"Name","minLength":1,"type":"string","description":"Name of item.","example":"Kalem"},"brandName":{"title":"Brandname","minLength":1,"type":"string","description":"Item brand name","example":"Sony"},"qty":{"title":"Qty","type":"number","description":"Quantiy of item","example":1},"unitPrice":{"title":"Unitprice","type":"number","description":"Unit Price","example":10.2},"category":{"title":"Category","type":"integer","description":"Item category. This must be the one of our ids in the Shopping Credit Item Categories. You can reach the list of categories on the Shopping Credit Item Categories Api.","example":16}}},"models__payment_request__ShoppingCreditCustomer":{"title":"ShoppingCreditCustomer","required":["birthDate","phoneNumber","nationalIdentityNumber"],"type":"object","properties":{"birthDate":{"title":"Birthdate","type":"string","description":"Customer Birth Date","example":"24091999"},"phoneNumber":{"title":"Phonenumber","type":"string","description":"Customer Phone Number","example":"05325408090"},"nationalIdentityNumber":{"title":"Nationalidentitynumber","type":"string","description":"Customer TC number","example":""},"ip_address":{"title":"Ip Address","type":"string","description":"IP address of client.","default":"","example":"1.1.111.111"},"email":{"title":"Email","type":"string","description":"Email of your customer.","default":"","example":"ahmetyigit@xyz.com"}}},"models__query_bin_response__CardTypeEnum":{"title":"CardTypeEnum","enum":["Unknown","Debit","Credit","Credit-Business"],"type":"string","description":"An enumeration."},"models__query_bin_response__PosDevice":{"title":"PosDevice","type":"object","properties":{"id":{"title":"Id","type":"integer","description":"Physical POS Device Id","default":0,"example":"5"},"name":{"title":"Name","type":"string","description":"Physical POS Device Name","default":"","example":"POS - 2"}}},"models__shopping_credit_option_response__Installment":{"title":"Installment","type":"object","properties":{"installment_count":{"title":"Installment Count","type":"integer","description":"Installment Count","default":1,"example":"7"},"installment_amount":{"title":"Installment Amount","type":"number","description":"Installment Amount","default":0,"example":1.12},"cost_rate":{"title":"Cost Rate","type":"number","description":"Cost rate of this installment count","default":0,"example":1.12},"customer_rate":{"title":"Customer Rate","type":"number","description":"Customer rate of this installment count","default":0,"example":1.35},"min_customer_rate":{"title":"Min Customer Rate","type":"number","description":"Minimum customer rate of this installment count","default":0,"example":1.35},"max_customer_rate":{"title":"Max Customer Rate","type":"number","description":"Maximum customer rate of this installment count","default":0,"example":1.35},"min_amount":{"title":"Min Amount","type":"integer","description":"This option can bu used with mininum this amount. If it is zero there is no limitations","default":0,"example":2},"max_amount":{"title":"Max Amount","type":"integer","description":"This option can bu used with maximum this amount. If it is zero there is no limitations","default":0,"example":2}}},"models__shopping_credit_pre_approved_request__ShoppingCreditBasketItem":{"title":"ShoppingCreditBasketItem","required":["id","name","brandName","qty","unitPrice","category"],"type":"object","properties":{"id":{"title":"Id","minLength":1,"type":"string","description":"Item id","example":"KL015"},"name":{"title":"Name","minLength":1,"type":"string","description":"Name of item.","example":"Kalem"},"brandName":{"title":"Brandname","minLength":1,"type":"string","description":"Item brand name","example":"Sony"},"qty":{"title":"Qty","type":"number","description":"Quantiy of item","example":1},"unitPrice":{"title":"Unitprice","type":"number","description":"Unit Price","example":10.2},"category":{"title":"Category","type":"integer","description":"Item category. This must be the one of our ids in the Shopping Credit Item Categories. You can reach the list of categories on the Shopping Credit Item Categories Api.","example":16}}},"models__shopping_credit_pre_approved_request__ShoppingCreditCustomer":{"title":"ShoppingCreditCustomer","required":["birthDate","phoneNumber","nationalIdentityNumber"],"type":"object","properties":{"birthDate":{"title":"Birthdate","type":"string","description":"Customer Birth Date","example":"24091999"},"phoneNumber":{"title":"Phonenumber","type":"string","description":"Customer Phone Number","example":"05325408090"},"nationalIdentityNumber":{"title":"Nationalidentitynumber","type":"string","description":"Customer TC number","example":""}}},"models__shopping_credit_pre_approved_response__Installment":{"title":"Installment","type":"object","properties":{"term":{"title":"Term","type":"integer","description":"Installment Count","default":1,"example":"7"},"interest_rate":{"title":"Interest Rate","type":"number","description":"Cost rate of this installment count","default":0,"example":1.12},"amount":{"title":"Amount","type":"number","description":"Installment Amount","default":0,"example":1.12},"total_payment_amount":{"title":"Total Payment Amount","type":"number","description":"Total Amount","default":0,"example":1.12},"annual_effective_interest_rate":{"title":"Annual Effective Interest Rate","type":"number","description":"Annual Interest Rate","default":0,"example":1.12}}},"routers__payments__StatusChangeEventReceived":{"title":"StatusChangeEventReceived","type":"object","properties":{"ok":{"title":"Ok","type":"string","description":"Payment is Successful","default":"OK","example":"OK"}}},"routers__shopping_credit__StatusChangeEventReceived":{"title":"StatusChangeEventReceived","type":"object","properties":{"ok":{"title":"Ok","type":"string","description":"Payment is Successful","default":"OK","example":"OK"}}},"routers__softpos__StatusChangeEventReceived":{"title":"StatusChangeEventReceived","type":"object","properties":{"ok":{"title":"Ok","type":"string","description":"Payment is Successful","default":"OK","example":"OK"}}},"routers__wallet_pay__StatusChangeEventReceived":{"title":"StatusChangeEventReceived","type":"object","properties":{"ok":{"title":"Ok","type":"string","description":"Payment is Successful","default":"OK","example":"OK"}}},"routers__wiretransfer__StatusChangeEventReceived":{"title":"StatusChangeEventReceived","type":"object","properties":{"ok":{"title":"Ok","type":"string","description":"Payment is Successful","default":"OK","example":"OK"}}}}},"tags":[{"name":"API Description","description":"Jet Checkout API, it connects any payment API, you dont need the think of that how to integrate many payment services","externalDocs":{"description":"You can find here Postman Collection to start development and test","url":"https://api.jetcheckout.com/api/v1/documents/postman_collection"}}]}