_shared-client-os-type
Client and OS Type Options
client and os_type parameters are supported by the following payment methods:alipay · alipay_cn · alipay_hk · boost · bpi · dana · gcash · kakao_pay · maya · rabbit_line_pay · tng · truemoneypayment_method_options.{method} when creating a PaymentIntent.Parameters
| Parameter | Type | Required | Values | Default | Description |
|---|---|---|---|---|---|
client | string | No | web, wap, app, mini_app | web | The client platform type used to initiate the payment. |
os_type | string | Conditional | ios, android | — | The operating system of the shopper's device. Required when client is wap or app. |
client values
| Value | Description |
|---|---|
web | Payment initiated from a PC browser. This is the default. |
wap | Payment initiated from a mobile browser. |
app | Payment initiated from a mobile application. |
mini_app | Payment initiated from a mini program. Not supported by all payment methods — see Mini App support below. |
os_type values
| Value | Description |
|---|---|
ios | The shopper is using an iOS device. |
android | The shopper is using an Android device. |
os_typeis required whenclientiswaporapp. It must not be set whenclientiswebormini_app.
Client scenario reference
| Payment Scenario | client | os_type |
|---|---|---|
| PC Web | web | Not required |
| Mobile Web — iOS | wap | ios |
| Mobile Web — Android | wap | android |
| Mobile App — iOS | app | ios |
| Mobile App — Android | app | android |
| Mini App | mini_app | Not required |
Mini App support
mini_app is only supported by the following payment methods:alipay_cn · alipay_hk · dana · gcash · tng · truemoneyclient to mini_app for any other payment method (e.g. alipay, boost, bpi, kakao_pay, maya, rabbit_line_pay) will result in a validation error.Reference: Alipay+ Cashier Payment — Accept payments with Mini Program
Request examples
{method} with the actual payment method name (e.g. gcash, truemoney).PC Web
{
"payment_method_options": {
"{method}": {
"client": "web"
}
}
}client defaults to web, so it can be omitted:{
"payment_method_options": {
"{method}": {}
}
}Mobile Web — iOS
{
"payment_method_options": {
"{method}": {
"client": "wap",
"os_type": "ios"
}
}
}Mobile Web — Android
{
"payment_method_options": {
"{method}": {
"client": "wap",
"os_type": "android"
}
}
}Mobile App — iOS
{
"payment_method_options": {
"{method}": {
"client": "app",
"os_type": "ios"
}
}
}Mobile App — Android
{
"payment_method_options": {
"{method}": {
"client": "app",
"os_type": "android"
}
}
}Mini App
Only supported for: alipay_cn,alipay_hk,dana,gcash,tng,truemoney.
{
"payment_method_options": {
"{method}": {
"client": "mini_app"
}
}
}