Client and OS Type Options

The client and os_type parameters are supported by the following payment methods:

boost · bpi · dana · gcash · maya · rabbit_line_pay · tng · truemoney

Set these parameters inside payment_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`.

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.

Value	Description
`ios`	The shopper is using an iOS device.
`android`	The shopper is using an Android device.

os_type is required when client is wap or app. It must not be set when client is web or mini_app.

Replace {method} with the actual payment method name (e.g. gcash, truemoney).

{
  "payment_method_options": {
    "{method}": {
      "client": "web"
    }
  }
}

client defaults to web, so it can be omitted:

{
  "payment_method_options": {
    "{method}": {}
  }
}

{
  "payment_method_options": {
    "{method}": {
      "client": "wap",
      "os_type": "ios"
    }
  }
}

{
  "payment_method_options": {
    "{method}": {
      "client": "wap",
      "os_type": "android"
    }
  }
}

{
  "payment_method_options": {
    "{method}": {
      "client": "app",
      "os_type": "ios"
    }
  }
}

{
  "payment_method_options": {
    "{method}": {
      "client": "app",
      "os_type": "android"
    }
  }
}

{
  "payment_method_options": {
    "{method}": {
      "client": "mini_app"
    }
  }
}