Profile Info
How to found#
Gateway> Integration> Profile
ksher.place.order or th.redirect.new.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| channel_list | String(128) | YES | alipay,wechat,linepay,airpay,promptpay,truemoney,card,ktc_instal | Payment Merchant list support. Value range: alipay: Alipay Wallet. wechat: Wechat Wallet. linepay: Rabbit LINE Pay Wallet. airpay: Shopeepay Wallet. truemoney: TrueMoney Wallet. atome: Atome Buy now pay later. minimum of 20 Baht. promptpay: PromptPay QR code (Thailand standard bank transfer QR code). scb_easy: SCB EASY Mobile App. minimum of 20 Baht. (only support on mobile). bbl_deeplink: Bualuang mBanking Mobile App. minimum of 20 Baht. (only support on mobile). baybank_deeplink: KMA Krungsri Mobile App. minimum of 20 Baht. (only support on mobile).. kplus: KPLUS. minimum of 20 Baht. (only support on mobile). card: Card Gateway. support Visa Card, Master Card, Union Pay Card, TPN Card ktc_instal: KTC Installment. support only KTC Card. minimum of 3,000 Baht. kbank_instal: KBANK Installment. support only KBANK Card. minimum of 3,000 Baht. kcc_instal: Krungsri Installment. support only Krungsri Card. minimum of 3,000 Baht.(5,000 Baht. for 10 months or more than) kfc_instal: First Choice Installment. support only Krungsri First Choice Card. minimum of 3,000 Baht. If multiple e-payment method required,a string made up by required e-wallets ,which seperated by "," without space, for example: "promptpay,linepay,airpay,truemoney,atome,card,ktc_instal,kbank_instal,kcc_instal,kfc_instal,scb_easy,bbl_deeplink,baybank_deeplink,kplus,alipay,wechat",card,ktc_instal,kbank_instal,kcc_instal,kfc_instal". will open all of channel your merchant you have. It will send Ksher checkout page to select your wallet want to paid. If you send only one channel, it will be redirected to each wallet you send. |
| mch_code | String(256) | YES | 123456acb | Order No. It will be display to customer. |
| product_name | String(512) | YES | Demo | Name or description of your product |
| refer_url | String(256) | YES | The URL of the merchant website homepage. If the merchant doesn't have a website, the merchant app download address can be used for this field. | |
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| device | String( ) | NO | H5 | Value Range:PC, H5; If you leave this blank, Ksher will determine user device automatically and will return an adaptive page. |
| member_id | String(32) | NO | ABC12345 | User ID, support ktb storage card function when user ID is transmitted. Can't use Real number like 1,1200,00001, but can use string with number like ABC1234. |
| color | String(32) | NO | #FF5C72 | The color code of banner on payment page, which can be DIY by merchant. |
| background | String | NO | https://img.examplefile.com/image1.png | The url of banner background picture on payment page, which can be DIY by merchant. |
| payment_color | String | NO | #FF5C72 | The color code of payment button, which can be DIY by merchant. |
| ksher_explain | String(256) | NO | Copyright information on payment page, which can be DIY by merchant. | |
| hide_explain | Integer | NO | 0 | Value range:0,1; 1: to display an expiration timer. 0: to hide expire time information. Default is "1". |
| expire_time | Integer | NO | 30 | How long the payment is valid to pay, the unit is minute. If merchant leave this blank, there will be no time limit. expire_time will only close link payment to not allow customer access to pay after link expire. If customer save QR to their local device. Customer still can make payment. |
| hide_exp_time | Integer | NO | 1 | Value range:0,1; 1: to display an expiration timer. 0: to hide expire time information. Default is "1". |
| logo | String | NO | https://file.ksher.cn/ksherbd/h5/2020325/201654.png | The url of logo picture on payment page, which can be DIY by merchant. |
| lang | String | NO | en | The display language. Value range: en for English, cn for Chinese, th for Thai. Default is en. |
| shop_name | String | NO | The Remark or description | |
| instal_fee_payer | String | NO | Who is carrying charge on installment fee. Value range:1, 2 1 : Means that the consumer bears the installment fee 2 : Indicates that the merchant bears the installment fee The default value is 1 if you want to customize depend on each channel, please not use "instal_fee_payer", switch to use value "instal_fee_payer_merchant" | |
| exclusive | Integer | NO | Limit to open link only one person. Value Range:1, 2 1: Limit people who click on the link to only one person. 2: not limit. The default value is 1 | |
| instal_fee_payer_merchant_channel_list | String | NO | "ktc_instal,kbank_instal" | Which payment channel merchant has to absorb interest rate, available for multiple channels. Example if send "instal_fee_payer_merchant_channel_list":"kbank_instal" customer who paid by KBANK Installment merchant will bears the installment fee. But another Installment channels, consumer bears the installment fee. |
| channel_instal_times_list | String | NO | "{\"ktc_instal\": [3,4,5], \"kbank_instal\": [4,5,6,7,8]}" | Installment period, available for multiple channels. Example if send "channel_instal_times_list": "{\"ktc_instal\": [3,4,5], \"kbank_instal\": [4,5,6,7,8]}" customer who paid by KTC Installment will display 3/4/5 months available to paid. KBANK Installment will display 4/5/6/7/8 months available to paid. Please send this value in JSON Objects convert to string format, don’t send in JSON Objects, because it will error signature. |
ksher.refund.order or th.redirect.refund.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| device_id | String(32) | NO | POS001 | the terminal device id from which the request is issued. |
| operator id | String(32) | NO | 10209 | the cashier ID at the merchant. |
| version | String(32) | NO | API version |
ksher.cscanb.order or th.cscanb.new.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| fee_type | String(16) | YES | THB | Currency code for total_fee. refer to with ISO 4217 |
| notify_url | String(256) | NO | http://www.myweb.com/wepay/pay_notify | the url to receive the asynchronous notification about the status of the payment from Ksher; If merchant leaves this field blank, then there will be no notification to send back to merchant. |
| img_type | String(3) | No | "png" | Ksher system can generate two types of the QR code image: png, svg. the default is png |
| product | String(512) | NO | Name or description of your product info. | |
| device_id | String(32) | NO | POS001 | terminal id from which the request is sent, assigned by merchant. |
| version | String(32) | NO | 3.0.0 | version api |
| expire_time | Int | NO | 60 | QR time available in second (support Truemoney and PromptPay only) If merchant leave this blank, expire time will be default on wallet. Example 60 is mean QR can use in 60 second after generate. |
th.cscanb.refund.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| device_id | String(32) | NO | POS001 | the terminal device id from which the request is issued. |
| operator id | String(32) | NO | 10209 | the cashier ID at the merchant. |
| version | String(32) | NO | API version |
ksher.bscanc.order or th.bscanc.new.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| product | String(512) | NO | product info. | |
| device_id | String(32) | NO | POS001 | the terminal device id from which the request is issued. |
| operator id | String(32) | NO | 10209 | the cashier ID at the merchant. |
th.bscanc.refund.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| device_id | String(32) | NO | POS001 | the terminal device id from which the request is issued. |
| operator id | String(32) | NO | 10209 | the cashier ID at the merchant. |
| version | String(32) | OPTINAL | API version |
ksher.miniapp.order or th.miniapp.new.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| channel | String(32) | YES | Value range: wechat/alipay | |
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| notify_url | String(256) | NO | http://www.myweb.com/wepay/pay_notify | the url to receive the asynchronous notification about the status of the payment from Ksher; If merchant leaves this field blank, then there will be no notification to send back to merchant. |
| product | String(512) | YES | Product name etc. info can be put here. | |
| device_id | String(32) | NO | POS001 | the terminal device id from which the request is issued. |
| sub_openid | YES | user id of the sub_appid in WeChat mini progarm | ||
| channel_sub_appid | YES | channel_sub_appid is your appid in WeChat |
th.miniapp.refund.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| device_id | String(32) | NO | POS001 | the terminal device id from which the request is issued. |
| operator id | String(32) | NO | 10209 | the cashier ID at the merchant. |
| version | String(32) | OPTINAL | API version |
th.app.new.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| channel | String(32) | YES | Value range: wechat/alipay/airpay/linepay | |
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| channel_sub_appid | String(32) | NO | appid of app. The parameter channel is required when its value is wechat | |
| notify_url | String(256) | NO | http://www.myweb.com/wepay/pay_notify | the url to receive the asynchronous notification about the status of the payment from Ksher; If merchant leaves this field blank, then there will be no notification to send back to merchant. |
| redirect_url | String(256) | YES | http://www.myweb.com/wepay/pay_notify | the url of payment result page, to which redirected from Ksher Payment Page. |
| product | String(512) | YES | Product name etc. info can be put here. | |
| device_id | String(32) | NO | POS001 | the terminal device id from which the request is issued. |
| refer_url | String(256) | YES(only for Alipay) | 10209 | url for download merchants app |
| operator_id | String(32) | NO | 10209 | the cashier ID at the merchant. |
| version | String(32) | NO | API version |
th.app.refund.order#
Configuration
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| fee_type | String(16) | YES | THB | Currency code. refer to with ISO 4217 |
| device_id | String(32) | NO | POS001 | the terminal device id from which the request is issued. |
| operator id | String(32) | NO | 10209 | the cashier ID at the merchant. |
| version | String(32) | NO | API version |