# Create checkout payment

> Create a checkout payment and obtain the redirectUrl for the Onerway-hosted payment page.

```yaml
openapi: 3.1.0
info:
  title: Create checkout payment
  version: 1.0.0
  description: Create a checkout payment and obtain the redirectUrl for the
    Onerway-hosted payment page.
paths:
  /txn/payment:
    post:
      summary: Create checkout payment
      description: Create a checkout payment and obtain the redirectUrl for the
        Onerway-hosted payment page.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                billingInformation:
                  type: string
                  description: Transaction billing information, including customer billing address
                    and contact details.
                  contentMediaType: application/json
                  contentSchema:
                    type: object
                    properties:
                      firstName:
                        type: string
                        description: Customer first name.
                      lastName:
                        type: string
                        description: Customer last name.
                      jpFirstName:
                        type: string
                        description: Customer first name in Japanese Katakana. Required only for Japan
                          payment methods and Japan-issued cards.
                      jpLastName:
                        type: string
                        description: Customer last name in Japanese Katakana. Required only for Japan
                          payment methods and Japan-issued cards.
                      phone:
                        type: string
                        description: Customer phone number, local part only (without country code); pass
                          the country code separately in `phoneCountryCode`,
                          which combines with this field into the full number.
                          Onerway does not strictly validate the format.
                      phoneCountryCode:
                        type: string
                        description: Country dialing code of the customer phone number, digits only
                          without `+`; combines with `phone` to form the full
                          number.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when `lpmsType=MB_WAY`.
                      email:
                        type: string
                        description: Customer email address; used for transaction confirmations and
                          dispute handling.
                      postalCode:
                        type: string
                        description: Postal or ZIP code. Commonly used by AVS checks.
                      address:
                        type: string
                        description: Full address in a single field. It can replace split street, house
                          number, and city fields for general address capture,
                          but should not be used as the only address input when
                          AVS is required.
                      country:
                        type: string
                        description: Country in [ISO 3166-1
                          alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
                          format.
                      province:
                        type: string
                        description: Province or state code in [ISO
                          3166-2](https://en.wikipedia.org/wiki/ISO_3166-2#Current_codes)
                          format.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when `country` is `US` or `CA`.
                      city:
                        type: string
                        description: City name. Recommended when AVS or a complete billing address is
                          required to improve address completeness,
                          authorization rate, and risk checks. Actual validation
                          dimensions vary by issuer and region.
                      street:
                        type: string
                        description: Street name. When AVS is enabled, provide it separately with
                          `number`, `postalCode`, and `city` as billing-address
                          verification data instead of relying only on the full
                          `address` field.
                      number:
                        type: string
                        description: House or building number. When AVS is enabled, provide it
                          separately with `street`, `postalCode`, and `city` as
                          billing-address verification data.
                      identityNumber:
                        type: string
                        description: Government-issued identity identifier, usually required by selected
                          local payment methods. It may be a national ID number
                          or a personal tax number.
                      birthDate:
                        type: string
                        description: Birth date in `yyyy/MM/dd` format.
                    required:
                      - email
                      - country
                  x-onerway-format: json_string
                cardInfo:
                  type: string
                  description: Card payment information. Checkout currently supports only
                    `holderName`; when provided, it pre-fills the cardholder
                    name on the hosted checkout form.
                  contentMediaType: application/json
                  contentSchema:
                    type: object
                    properties:
                      holderName:
                        type: string
                        description: Cardholder name. When provided, it pre-fills the hosted checkout
                          payment form.
                  x-onerway-format: json_string
                lpmsInfo:
                  type: string
                  description: Local payment method information. When used with `productType=ALL`,
                    setting `lpmsType` limits checkout to the specified local
                    payment method.
                  contentMediaType: application/json
                  contentSchema:
                    type: object
                    properties:
                      lpmsType:
                        type: string
                        description: Local payment method type.
                        enum:
                          - GooglePay
                          - ApplePay
                          - JdPay
                          - Alipay+
                          - WeChat
                          - AlipayHK
                          - AlipayCN
                          - Kakao_Pay
                          - Klarna
                          - Boleto
                          - BankTransfer
                          - Banrisul
                          - Bradesco
                          - Banco do Brasil
                          - Itau
                          - MercadoPago
                          - PIX
                          - Servipag
                          - Sencillito
                          - Webpay
                          - Multicaja
                          - Baloto
                          - EFT
                          - Efecty
                          - SPEI
                          - OXXO
                          - OXXOPAY
                          - PagoEfectivo
                          - safetypay-cash
                          - safetypay-online
                          - PayU
                          - Przelewy24
                          - Pagosnet
                          - SEPADD
                          - Sofort
                          - Giropay
                          - iDEAL
                          - Konbini
                          - PayEasy
                          - POLi
                          - Bancontact
                          - OVO
                          - MyBank
                          - Dragonpay
                          - Skrill
                          - eNETS
                          - PayseraWallet
                          - LithuanianBanks
                          - PaySafeCard
                          - Paysafecash
                          - Payconiq
                          - Trustly
                          - PAY_BY_BANK
                          - GCash
                          - GrabPay
                          - PayMaya
                          - ELEVEN
                          - GrabPay SG
                          - TrueMoney Wallet
                          - Rabbit_Line_pay
                          - PromptPay
                          - KRUNGSRI_ONLINE
                          - BUALUANG_IBANKING
                          - CITI_POINTS
                          - K_PLUS
                          - MCASH
                          - TOUCH_GO_EWALLET
                          - ShopeePay
                          - Boost
                          - BNI
                          - MANDIRI
                          - Maybank
                          - PERMATA
                          - BRI
                          - CIMB
                          - DANA
                          - QRIS
                          - AKULAKU
                          - Paypay
                          - LINE_Pay
                          - Merpay
                          - Rakuten_Pay
                          - BitCash
                          - Net_Cash
                          - WebMoney
                          - au
                          - SoftBank
                          - NTT_Docomo
                          - Paidy
                          - BLIK
                          - BLIK_SEAMLESS
                          - cardpay
                          - stcpay
                          - tamara
                          - tabby
                          - MB_WAY
                        x-enum-descriptions:
                          GooglePay: Google Pay wallet payment method.
                          ApplePay: Apple Pay wallet payment method.
                          JdPay: JD Pay payment method.
                          Alipay+: Alipay+ payment method.
                          WeChat: WeChat Pay payment method.
                          AlipayHK: AlipayHK payment method.
                          AlipayCN: Alipay payment method in mainland China.
                          Kakao_Pay: Kakao Pay payment method.
                          Klarna: Klarna payment method.
                          Boleto: Boleto payment method.
                          BankTransfer: Bank transfer payment method.
                          Banrisul: Banrisul bank payment method.
                          Bradesco: Bradesco bank payment method.
                          Banco do Brasil: Banco do Brasil bank payment method.
                          Itau: Itaú bank payment method.
                          MercadoPago: Mercado Pago payment method.
                          PIX: PIX instant payment method.
                          Servipag: Servipag payment method.
                          Sencillito: Sencillito payment method.
                          Webpay: Webpay payment method.
                          Multicaja: Multicaja payment method.
                          Baloto: Baloto cash payment method.
                          EFT: Electronic funds transfer payment method.
                          Efecty: Efecty cash payment method.
                          SPEI: SPEI bank transfer payment method.
                          OXXO: OXXO cash voucher payment method.
                          OXXOPAY: OXXO Pay payment method.
                          PagoEfectivo: PagoEfectivo cash payment method.
                          safetypay-cash: SafetyPay Cash payment method.
                          safetypay-online: SafetyPay Online payment method.
                          PayU: PayU payment method.
                          Przelewy24: Przelewy24 payment method.
                          Pagosnet: Pagosnet payment method.
                          SEPADD: SEPA Direct Debit payment method.
                          Sofort: Sofort payment method.
                          Giropay: giropay payment method.
                          iDEAL: iDEAL payment method.
                          Konbini: Konbini convenience store payment method.
                          PayEasy: Pay-easy payment method.
                          POLi: POLi payment method.
                          Bancontact: Bancontact payment method.
                          OVO: OVO wallet payment method.
                          MyBank: MyBank payment method.
                          Dragonpay: Dragonpay payment method.
                          Skrill: Skrill payment method.
                          eNETS: eNETS payment method.
                          PayseraWallet: Paysera Wallet payment method.
                          LithuanianBanks: Lithuanian bank payment method.
                          PaySafeCard: paysafecard prepaid payment method.
                          Paysafecash: paysafecash payment method.
                          Payconiq: Payconiq payment method.
                          Trustly: Trustly payment method.
                          PAY_BY_BANK: Pay by Bank payment method.
                          GCash: GCash wallet payment method.
                          GrabPay: GrabPay wallet payment method.
                          PayMaya: Maya wallet payment method.
                          ELEVEN: 7-Eleven payment method.
                          GrabPay SG: GrabPay Singapore wallet payment method.
                          TrueMoney Wallet: TrueMoney Wallet payment method.
                          Rabbit_Line_pay: Rabbit LINE Pay payment method.
                          PromptPay: PromptPay payment method.
                          KRUNGSRI_ONLINE: Krungsri Online banking payment method.
                          BUALUANG_IBANKING: Bualuang iBanking payment method.
                          CITI_POINTS: Citi Rewards Points payment method.
                          K_PLUS: K PLUS payment method.
                          MCASH: MCash wallet payment method.
                          TOUCH_GO_EWALLET: Touch 'n Go eWallet payment method.
                          ShopeePay: ShopeePay wallet payment method.
                          Boost: Boost wallet payment method.
                          BNI: BNI virtual account payment method.
                          MANDIRI: Mandiri virtual account payment method.
                          Maybank: Maybank virtual account payment method.
                          PERMATA: Permata virtual account payment method.
                          BRI: BRI virtual account payment method.
                          CIMB: CIMB virtual account payment method.
                          DANA: DANA wallet payment method.
                          QRIS: QRIS payment method.
                          AKULAKU: Akulaku payment method.
                          Paypay: PayPay payment method.
                          LINE_Pay: LINE Pay payment method.
                          Merpay: Merpay payment method.
                          Rakuten_Pay: Rakuten Pay payment method.
                          BitCash: BitCash payment method.
                          Net_Cash: NetCash payment method.
                          WebMoney: WebMoney payment method.
                          au: au PAY payment method.
                          SoftBank: SoftBank carrier payment method.
                          NTT_Docomo: d払い (Docomo) carrier payment method.
                          Paidy: Paidy payment method.
                          BLIK: BLIK payment method.
                          BLIK_SEAMLESS: BLIK Seamless payment method.
                          cardpay: MADA payment method.
                          stcpay: stc pay payment method.
                          tamara: Tamara payment method.
                          tabby: Tabby payment method.
                          MB_WAY: MB Way payment method.
                      bankName:
                        type: string
                        description: Bank identifier. Send the enum item `value`; `description` is only
                          the bank name display text.
                        enum:
                          - banco_agrario
                          - banco_av_villas
                          - banco_bbva_colombia_s.a.
                          - banco_caja_social
                          - banco_colpatria
                          - banco_cooperativo_coopcentral
                          - banco_corpbanca_s.a
                          - banco_davivienda
                          - banco_de_bogota
                          - banco_de_occidente
                          - bancofalabella
                          - banco_gnb_sudameris
                          - banco_pichincha_s.a.
                          - banco_procredit
                          - bancolombia
                          - bancoomeva_s.a.
                          - citibank_
                          - itau
                          - nequi
                          - "20"
                          - "26"
                          - "31"
                          - "33"
                          - "43"
                          - "45"
                          - "49"
                          - "52"
                          - "53"
                          - "54"
                          - "64"
                          - "65"
                          - "69"
                          - "85"
                          - "88"
                          - "90"
                          - "95"
                          - "99"
                          - "112"
                          - "119"
                          - "129"
                          - "131"
                          - "136"
                          - "141"
                          - "143"
                          - "144"
                          - "153"
                          - "154"
                          - "158"
                          - "161"
                          - "185"
                          - "222"
                          - "223"
                          - "243"
                          - "266"
                          - "270"
                          - "271"
                          - "272"
                          - "274"
                          - "275"
                          - "279"
                          - "280"
                        x-onerway-enum-variants:
                          - title: EFT
                            when: When `lpmsType=EFT`.
                            values:
                              - value: banco_agrario
                                description: BANCO AGRARIO
                              - value: banco_av_villas
                                description: BANCO AV VILLAS
                              - value: banco_bbva_colombia_s.a.
                                description: BANCO BBVA COLOMBIA S.A.
                              - value: banco_caja_social
                                description: BANCO CAJA SOCIAL
                              - value: banco_colpatria
                                description: BANCO COLPATRIA
                              - value: banco_cooperativo_coopcentral
                                description: BANCO COOPERATIVO COOPCENTRAL
                              - value: banco_corpbanca_s.a
                                description: BANCO CORPBANCA S.A
                              - value: banco_davivienda
                                description: BANCO DAVIVIENDA
                              - value: banco_de_bogota
                                description: BANCO DE BOGOTA
                              - value: banco_de_occidente
                                description: BANCO DE OCCIDENTE
                              - value: bancofalabella
                                description: BANCO FALABELLA
                              - value: banco_gnb_sudameris
                                description: BANCO GNB SUDAMERIS
                              - value: banco_pichincha_s.a.
                                description: BANCO PICHINCHA S.A.
                              - value: banco_procredit
                                description: BANCO PROCREDIT
                              - value: bancolombia
                                description: BANCOLOMBIA
                              - value: bancoomeva_s.a.
                                description: BANCOOMEVA S.A.
                              - value: citibank_
                                description: CITIBANK
                              - value: itau
                                description: ITAU
                              - value: nequi
                                description: NEQUI
                          - title: Przelewy24
                            when: When `lpmsType=Przelewy24`.
                            values:
                              - value: "20"
                                description: Santander Bank Polska - Pretzel24 payment system
                              - value: "26"
                                description: Pay with Inteligo
                              - value: "31"
                                description: Pay with iPKO (PKO BP)
                              - value: "33"
                                description: BNP Paribas banking group
                              - value: "43"
                                description: Bank Polska Kasa Opieki Spółka Akcyjna
                              - value: "45"
                                description: Credit Agricole banking group
                              - value: "49"
                                description: ING Bank Śląski
                              - value: "52"
                                description: Inteligo Account
                              - value: "53"
                                description: Powszechna Kasa Oszczędności Bank Polski (iPKO)
                              - value: "54"
                                description: Santander Bank Polska
                              - value: "64"
                                description: Toyota Bank
                              - value: "65"
                                description: Bank Polska Kasa Opieki Spółka Akcyjna
                              - value: "69"
                                description: Volkswagen Bank
                              - value: "85"
                                description: Bank Millennium S.A.
                              - value: "88"
                                description: Pay with Alior Bank
                              - value: "90"
                                description: Nest Bank
                              - value: "95"
                                description: Credit Agricole banking group
                              - value: "99"
                                description: Pay with BOŚ Bank
                              - value: "112"
                                description: Pay with ING Bank
                              - value: "119"
                                description: Pay with Citi Handlowy
                              - value: "129"
                                description: Alior Bank - Installment payments
                              - value: "131"
                                description: Pay with Plus Bank
                              - value: "136"
                                description: mBank - Installment payments
                              - value: "141"
                                description: E-transfer with Pocztowy24
                              - value: "143"
                                description: Cooperative Banks
                              - value: "144"
                                description: Bank Nowy BFG S.A.
                              - value: "153"
                                description: Getin Bank
                              - value: "154"
                                description: Polish mobile payment system
                              - value: "158"
                                description: Noble Pay payment system
                              - value: "161"
                                description: Pay with Idea Bank
                              - value: "185"
                                description: Envelope Bank
                              - value: "222"
                                description: Nest Bank Transfer
                              - value: "223"
                                description: BNP Paribas - Pay with Pl@net
                              - value: "243"
                                description: mBank - mTransfer service
                              - value: "266"
                                description: P24now payment service
                              - value: "270"
                                description: mBank (ITP Service)
                              - value: "271"
                                description: ING Bank Śląski (ITP Service)
                              - value: "272"
                                description: BNP Paribas (ITP Service)
                              - value: "274"
                                description: PKO BP (ITP Service)
                              - value: "275"
                                description: Santander (ITP Service)
                              - value: "279"
                                description: Inteligo (ITP Service)
                              - value: "280"
                                description: mBank - Installment payments
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when `lpmsType=EFT` or
                            `lpmsType=Przelewy24`.
                      walletAccountId:
                        type: string
                        description: Wallet or local account identifier.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when the selected local payment method
                            collects a wallet account or local account
                            identifier.
                      walletAccountName:
                        type: string
                        description: Wallet or local account name.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when the selected local payment method
                            collects a wallet or local account name.
                      iBan:
                        type: string
                        description: International Bank Account Number (IBAN).
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required for regional bank-transfer flows that use
                            IBAN for bank identification.
                      prepaidNumber:
                        type: string
                        description: Prepaid card or voucher number.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when the selected Japan prepaid payment
                            method collects a prepaid card or voucher number.
                    required:
                      - lpmsType
                  x-onerway-format: json_string
                merchantCustId:
                  type: string
                  description: Unique customer identifier in the merchant system.
                  x-onerway-constraints:
                    - kind: rule
                      text: For non-subscription checkout, provide it when you want the hosted
                        checkout page to offer saved-payment-method options.
                    - kind: consistency
                      text: For subscription checkout, use `subscription.merchantCustId` as the
                        required subscription customer identifier; if top-level
                        `merchantCustId` is submitted together with
                        `subscription.merchantCustId`, the two values must
                        match.
                merchantNo:
                  type: string
                  description: Merchant number assigned by Onerway. See
                    [Setup](/payments/get-started/setup#retrieve-your-credentials)
                    for how to obtain it.
                  x-onerway-constraints:
                    - kind: rule
                      text: In the platform model, submit the merchant number of the sub-merchant the
                        transaction is initiated for, not the platform merchant
                        number. The sub-merchant must already be registered with
                        Onerway.
                merchantTxnId:
                  type: string
                  description: Unique transaction identifier generated by the merchant system for
                    tracking, reconciliation, and duplicate prevention.
                merchantTxnTime:
                  type: string
                  description: Transaction timestamp when the merchant initiated the transaction,
                    in `yyyy-MM-dd HH:mm:ss` format. If omitted, Onerway records
                    the transaction time in UTC+8.
                merchantTxnTimeZone:
                  type: string
                  description: Timezone offset for `merchantTxnTime`. If omitted, Onerway records
                    the transaction time in UTC+8.
                metaData:
                  type: string
                  description: Custom data for this transaction, returned unchanged in transaction
                    queries and asynchronous notifications.
                  x-onerway-constraints:
                    - kind: rule
                      text: Must be a string containing valid JSON. When omitted, `metaData` is empty
                        in queries and notifications.
                    - kind: consistency
                      text: If both top-level `metaData` and `subscription.metaData` are submitted,
                        `subscription.metaData` takes precedence.
                orderAmount:
                  type: string
                  description: Transaction amount in the specified currency, formatted as a
                    decimal string. For zero-decimal currencies, the amount must
                    represent a whole amount; an all-zero decimal part is
                    accepted, while non-zero decimals are rejected. Format rules
                    follow [currency and amount
                    validation](/payments/get-started/currency-and-amount).
                orderCurrency:
                  type: string
                  description: Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)
                    transaction currency. Must match `orderAmount`.
                osType:
                  type: string
                  description: Operating system type for mobile and app-based checkout
                    transactions. Hosted checkout recommends `WEB` mode and
                    usually does not require this field.
                  enum:
                    - IOS
                    - ANDROID
                  x-enum-descriptions:
                    IOS: iOS device.
                    ANDROID: Android device.
                  x-onerway-required: conditional
                  x-onerway-condition:
                    - Required when `paymentMode` is `APP` or `WAP`.
                paymentMode:
                  type: string
                  description: Payment mode indicating the platform or environment for the
                    transaction. Checkout recommends the default `WEB` mode.
                  enum:
                    - WEB
                    - APP
                    - WAP
                  x-enum-descriptions:
                    WEB: Desktop browser payment.
                    APP: Native mobile app payment.
                    WAP: Mobile browser payment.
                paymentMethodOptions:
                  type: string
                  description: Payment method configuration options. Checkout supports the `card`
                    and `share` objects.
                  contentMediaType: application/json
                  contentSchema:
                    type: object
                    properties:
                      card:
                        type: object
                        properties:
                          avsEnabled:
                            type: boolean
                            description: Whether AVS (Address Verification Service) validation is enabled.
                              Contact Onerway before enabling it. When set to
                              `true`, the billing address is used for AVS checks
                              and results are returned in
                              `paymentMethodDetails.card.checks` through
                              transaction queries and webhooks.
                        description: Card-specific checkout options.
                      share:
                        type: object
                        properties:
                          profitShare:
                            type: boolean
                            description: Whether this transaction allows profit sharing. Enabling it is a
                              prerequisite for sharing this transaction later.
                              When `true` without `profitShareRate`, no amount
                              is split automatically; you can still initiate
                              profit sharing through the [Create or reverse
                              profit
                              share](/payments/api-reference/endpoints/create-or-reverse-profit-share)
                              endpoint with the `transactionId` returned by this
                              request.
                          profitShareNotifyUrl:
                            type: string
                            description: URL for automatic profit share and reversal notifications. If
                              omitted, no automatic profit share or reversal
                              notification is sent.
                            x-onerway-constraints:
                              - kind: consistency
                                text: A non-empty URL must use HTTPS and be submitted with `profitShare=true`;
                                  otherwise the payment request is rejected.
                              - kind: rule
                                text: The URL is saved only when `profitShare=true`. A `CAPTURE` transaction
                                  inherits the URL from its `AUTH` transaction.
                                  When the original payment has this URL, you
                                  can omit `urlCallback` from a subsequent
                                  profit share or reversal request.
                          profitShareRate:
                            type: string
                            description: Automatic profit-sharing percentage, where `1` means 1% and `100`
                              means 100%. Onerway allocates this portion to the
                              platform merchant automatically once a `SALE` or
                              `CAPTURE` succeeds; refunds and chargebacks return
                              the allocated portion at the same percentage.
                            x-onerway-constraints:
                              - kind: range
                                min: 1
                                max: 100
                                unit: percent
                              - kind: rule
                                text: Submit a whole number as a string. Decimals, `0`, negative values, and
                                  values above 100 are rejected.
                              - kind: consistency
                                text: Requires `profitShare=true`. Submitting a rate while `profitShare` is
                                  absent or `false` is rejected.
                        description: Profit-sharing options for the transaction. In the platform model,
                          part of the amount collected by the sub-merchant is
                          allocated to the platform merchant.
                        x-onerway-lifecycle:
                          status: new
                          since: 2026-08-10
                          description:
                            en: New object for transaction profit sharing.
                            zh: 交易分账的新增对象。
                  x-onerway-format: json_string
                productType:
                  type: string
                  description: Payment method display scope for the hosted checkout. It controls
                    which payment method categories the customer can choose
                    from; the processing model is further determined by
                    `subProductType` and `txnType`.
                  enum:
                    - ALL
                    - CARD
                  x-enum-descriptions:
                    ALL: Unified Checkout. Display all payment methods available for the merchant
                      and transaction conditions; when `lpmsInfo.lpmsType` is
                      also provided, display only the specified local payment
                      method.
                    CARD: Card-only checkout. Display card payment methods only; support for
                      authorization, subscriptions, installments, or saving
                      payment information still depends on `subProductType`,
                      `txnType`, and the merchant's enabled configuration.
                retailers:
                  type: string
                  description: Retailer information for marketplace transactions. Submit one entry
                    for each retailer whose products are included in this order.
                  contentMediaType: application/json
                  contentSchema:
                    type: array
                    items:
                      type: object
                      properties:
                        retailerId:
                          type: string
                          description: Unique retailer identifier defined by the merchant. Keep it unique
                            within your marketplace or merchant system. It is
                            not the Onerway sub-merchant number submitted in
                            `merchantNo`; the two are separate identifier
                            systems.
                          x-onerway-constraints:
                            - kind: range
                              max: 64
                              unit: characters
                        retailerName:
                          type: string
                          description: Retailer name. Prefer the registered legal name or the trading name
                            the retailer operates under.
                          x-onerway-constraints:
                            - kind: range
                              max: 128
                              unit: characters
                        retailerCountry:
                          type: string
                          description: Retailer country or region in [ISO 3166-1
                            alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
                            format.
                      required:
                        - retailerId
                        - retailerName
                        - retailerCountry
                  x-onerway-constraints:
                    - kind: rule
                      text: Applies to marketplace and platform models where products are sold by
                        third-party retailers rather than by the merchant
                        directly. Merchants selling only their own inventory do
                        not need to submit it.
                    - kind: consistency
                      text: When submitted, every entry in `txnOrderMsg.products` must carry a
                        `retailerId` that matches one of the retailers listed
                        here.
                  x-onerway-format: json_string
                  x-onerway-lifecycle:
                    status: new
                    since: 2026-08-10
                    description:
                      en: New field for marketplace retailer information.
                      zh: marketplace 零售商信息的新增字段。
                risk3dsStrategy:
                  type: string
                  description: 3DS risk strategy for checkout transactions.
                  enum:
                    - DEFAULT
                    - INNER
                    - NONE
                  x-enum-descriptions:
                    DEFAULT: Default strategy. Onerway decides whether to trigger 3DS based on the
                      transaction, merchant configuration, and risk controls.
                    INNER: Force Onerway-managed 3DS authentication.
                    NONE: Do not use 3DS authentication. Availability depends on merchant
                      configuration and risk requirements.
                  x-onerway-constraints:
                    - kind: unsupported
                      text: Checkout does not support `EXTERNAL`.
                    - kind: rule
                      text: Contact Onerway before specifying a non-default strategy.
                shippingInformation:
                  type: string
                  description: Transaction shipping information, including customer delivery
                    address and contact details.
                  contentMediaType: application/json
                  contentSchema:
                    type: object
                    properties:
                      firstName:
                        type: string
                        description: Customer first name.
                      lastName:
                        type: string
                        description: Customer last name.
                      jpFirstName:
                        type: string
                        description: Customer first name in Japanese Katakana. Required only for Japan
                          payment methods and Japan-issued cards.
                      jpLastName:
                        type: string
                        description: Customer last name in Japanese Katakana. Required only for Japan
                          payment methods and Japan-issued cards.
                      phone:
                        type: string
                        description: Customer phone number, local part only (without country code); pass
                          the country code separately in `phoneCountryCode`,
                          which combines with this field into the full number.
                          Onerway does not strictly validate the format.
                      phoneCountryCode:
                        type: string
                        description: Country dialing code of the customer phone number, digits only
                          without `+`; combines with `phone` to form the full
                          number.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when `lpmsType=MB_WAY`.
                      email:
                        type: string
                        description: Customer email address; used for transaction confirmations and
                          dispute handling.
                      postalCode:
                        type: string
                        description: Postal or ZIP code. Commonly used by AVS checks.
                      address:
                        type: string
                        description: Full address in a single field. It can replace split street, house
                          number, and city fields for general address capture,
                          but should not be used as the only address input when
                          AVS is required.
                      country:
                        type: string
                        description: Country in [ISO 3166-1
                          alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
                          format.
                      province:
                        type: string
                        description: Province or state code in [ISO
                          3166-2](https://en.wikipedia.org/wiki/ISO_3166-2#Current_codes)
                          format.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when `country` is `US` or `CA`.
                      city:
                        type: string
                        description: City name. Recommended when AVS or a complete billing address is
                          required to improve address completeness,
                          authorization rate, and risk checks. Actual validation
                          dimensions vary by issuer and region.
                      street:
                        type: string
                        description: Street name. When AVS is enabled, provide it separately with
                          `number`, `postalCode`, and `city` as billing-address
                          verification data instead of relying only on the full
                          `address` field.
                      number:
                        type: string
                        description: House or building number. When AVS is enabled, provide it
                          separately with `street`, `postalCode`, and `city` as
                          billing-address verification data.
                      identityNumber:
                        type: string
                        description: Government-issued identity identifier, usually required by selected
                          local payment methods. It may be a national ID number
                          or a personal tax number.
                      birthDate:
                        type: string
                        description: Birth date in `yyyy/MM/dd` format.
                    required:
                      - email
                      - country
                  x-onerway-format: json_string
                sign:
                  type: string
                  description: Request signature string. See [Request
                    signing](/payments/get-started/request-signing) for how to
                    generate it.
                subProductType:
                  type: string
                  description: Transaction processing mode under the selected payment method
                    scope.
                  enum:
                    - DIRECT
                    - SUBSCRIBE
                    - INSTALLMENT
                  x-enum-descriptions:
                    DIRECT: Ordinary checkout payment. Execute a one-time debit or authorization
                      according to `txnType`.
                    SUBSCRIBE: Initial subscription transaction. Used to create a subscription
                      contract through checkout; `subscription` is required, and
                      recurring billing, cancellation, and updates use the
                      corresponding subscription APIs.
                    INSTALLMENT: Installment transaction. `txnOrderMsg.periodValue` must use a
                      period value returned by the installment inquiry API.
                  x-onerway-constraints:
                    - kind: consistency
                      text: Works with `productType` and `txnType` to define the transaction model.
                    - kind: unsupported
                      text: Checkout does not support `TOKEN`.
                    - kind: rule
                      text: For saved-payment-method scenarios, pass `merchantCustId` in
                        non-subscription checkout flows or use
                        `subscription.bindCard` in hosted card subscription
                        flows.
                subscription:
                  type: string
                  description: Subscription information for creating or initializing a
                    subscription through Checkout. This endpoint is only for the
                    initial subscription request; subsequent billing,
                    cancellation, and updates use the corresponding subscription
                    APIs. Use `selfExecute=1` for Onerway-managed billing, or
                    `selfExecute=2` for merchant-managed billing.
                  contentMediaType: application/json
                  contentSchema:
                    type: object
                    properties:
                      requestType:
                        type: string
                        description: Subscription request type. Checkout subscription only supports `0`
                          for the initial subscription request. `1` is not
                          supported here and is used for subsequent billing
                          APIs.
                        enum:
                          - "0"
                        x-enum-descriptions:
                          "0": Initial subscription request.
                      merchantCustId:
                        type: string
                        description: Required subscription customer identifier in the merchant system,
                          used to associate the subscription contract, payment
                          method, and transaction records.
                        x-onerway-constraints:
                          - kind: consistency
                            text: If top-level `merchantCustId` is also submitted, it must match this value;
                              the top-level field may be omitted.
                      productName:
                        type: string
                        description: Subscription product or plan name. Required for Onerway-managed
                          subscriptions (`selfExecute=1`) and supported for
                          merchant-managed subscriptions (`selfExecute=2`) when
                          you need to identify the product or plan in the
                          subscription record. The same customer cannot purchase
                          the same product again before the existing
                          subscription ends.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required for Onerway-managed subscriptions
                            (`selfExecute=1`).
                      amountOff:
                        type: string
                        description: Fixed amount deducted from each eligible subscription charge during
                          the discount period.
                        x-onerway-constraints:
                          - kind: rule
                            text: Formatted as a decimal string. Currency and precision follow the top-level
                              `orderCurrency`; see [currency and amount
                              validation](/payments/get-started/currency-and-amount).
                          - kind: consistency
                            text: Must be greater than `0` and less than the top-level `orderAmount`, so the
                              actual charge remains greater than `0`.
                          - kind: unsupported
                            text: Not supported for renewal requests (`requestType=1`) or Onerway-managed
                              subscriptions (`selfExecute=1`).
                        x-onerway-lifecycle:
                          status: new
                          since: 2026-08-12
                          description:
                            en: New field for fixed-amount discounts on initial merchant-managed
                              subscription cycles.
                            zh: 非托管订阅前若干期固定金额优惠的新增字段。
                      amountOffCycleCount:
                        type: integer
                        description: Number of successful subscription charges that receive the
                          `amountOff` discount. When omitted, the discount
                          applies only to the first successful charge.
                        x-onerway-constraints:
                          - kind: range
                            min: 1
                            unit: cycles
                          - kind: consistency
                            text: Submit only together with `amountOff`. It is independent of the
                              managed-subscription `cycleCount` field.
                          - kind: rule
                            text: Only successful charges consume a discount cycle. Authorization-only,
                              failed, canceled, and pending transactions do not
                              consume one.
                          - kind: unsupported
                            text: Not supported for renewal requests (`requestType=1`) or Onerway-managed
                              subscriptions (`selfExecute=1`).
                        x-onerway-lifecycle:
                          status: new
                          since: 2026-08-12
                          description:
                            en: New field for extending a fixed-amount discount across multiple subscription
                              charges.
                            zh: 将固定金额优惠延续到多期订阅扣款的新增字段。
                      frequencyType:
                        type: string
                        description: Subscription billing frequency type.
                        enum:
                          - D
                          - M
                          - Y
                        x-enum-descriptions:
                          D: Bill by day.
                          M: Bill by month.
                          Y: Bill by year.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required for initial subscription purchases through
                            checkout.
                        x-onerway-constraints:
                          - kind: values
                            text: "`selfExecute=1` supports `D`, `M`, and `Y`; `selfExecute=2` supports `D`
                              only."
                      frequencyPoint:
                        type: string
                        description: Billing cycle length, in the unit specified by `frequencyType`.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required for initial subscription purchases through
                            checkout.
                        x-onerway-constraints:
                          - kind: values
                            text: "For `selfExecute=1`, allowed values are `1`, `7`, or `14` when
                              `frequencyType=D`; `1`, `3`, or `6` when
                              `frequencyType=M`; and only `1` when
                              `frequencyType=Y`. For `selfExecute=2`, there is
                              no fixed set of allowed values: submit the billing
                              cycle length in days — for example, `30` for a
                              monthly plan or `365` for an annual plan."
                          - kind: rule
                            text: "For `selfExecute=2`, this value is informational only: Onerway does not
                              use it to schedule charges, and does not validate
                              the timing of your charges against it. You
                              initiate every renewal charge yourself."
                      cycleCount:
                        type: integer
                        description: Number of Onerway-managed subscription cycles.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required for Onerway-managed subscriptions
                            (`selfExecute=1`) when the plan end is defined by a
                            fixed number of billing cycles.
                        x-onerway-constraints:
                          - kind: range
                            min: 1
                            max: 99
                            unit: cycles
                          - kind: unsupported
                            text: Not supported for `selfExecute=2`.
                      expireDate:
                        type: string
                        description: Subscription expiration date.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when the subscription end is defined by an
                            expiration date.
                        x-onerway-constraints:
                          - kind: consistency
                            text: Shares the maximum cycle count constraint with `cycleCount`; the
                              subscription derived from `frequencyType` and
                              `frequencyPoint` must not exceed `99` cycles.
                      mode:
                        type: string
                        description: How the first subscription payment is collected.
                        enum:
                          - "1"
                          - "2"
                        x-enum-descriptions:
                          "1": Obtain subscription authorization only; the first payment is collected by
                            the merchant later. Available only for self-managed
                            subscriptions (`selfExecute=2`).
                          "2": Collect the first payment once the customer has authorized; applicable to
                            card subscriptions and local payment methods that
                            require authorization.
                        x-onerway-constraints:
                          - kind: values
                            text: "`1` obtains subscription authorization only and lets the merchant collect
                              the first payment later; it is available only for
                              `selfExecute=2`."
                          - kind: rule
                            text: "`2` collects the first payment once the customer has authorized and is
                              the default when omitted."
                      selfExecute:
                        type: string
                        description: Subscription execution mode.
                        enum:
                          - "1"
                          - "2"
                        x-enum-descriptions:
                          "1": Automatic billing by Onerway according to the subscription plan.
                          "2": Merchant-triggered billing for each subscription cycle.
                      bindCard:
                        type: boolean
                        description: Whether to save the customer's card after the initial payment of an
                          Onerway-managed card subscription succeeds. Onerway
                          reports the result in a separate [Saved payment method
                          result
                          webhook](/payments/api-reference/webhooks/payment-method-result)
                          (`txnType=BIND_CARD`).
                        x-onerway-constraints:
                          - kind: rule
                            text: When the card is saved, the [Saved payment method result
                              webhook](/payments/api-reference/webhooks/payment-method-result)
                              returns `status=S` and the saved payment method
                              token in `tokenId`. Use that token for
                              `subProductType=TOKEN` payments through [Create
                              direct
                              transaction](/payments/api-reference/endpoints/direct-create-transaction);
                              Checkout does not support `subProductType=TOKEN`.
                              Subscription charges use `contractId` and
                              `tokenId` from the [Subscription payment
                              webhook](/payments/api-reference/webhooks/subscription-payment),
                              which is a different token.
                          - kind: rule
                            text: "Local payment method subscriptions ignore this field: Onerway always
                              sends a Saved payment method result webhook for
                              their subscription authorization."
                          - kind: unsupported
                            text: Not supported for `selfExecute=2`.
                      trialFromPlan:
                        type: string
                        description: Trial period billing mode for Onerway-managed subscriptions.
                        enum:
                          - "0"
                          - "1"
                        x-enum-descriptions:
                          "0": Trial period is not charged.
                          "1": Trial period is charged according to the subscription plan.
                        x-onerway-constraints:
                          - kind: values
                            text: "`0` means the trial period is not charged; `1` means it is charged
                              according to the plan."
                          - kind: unsupported
                            text: Not supported for `selfExecute=2`.
                      trialDays:
                        type: integer
                        description: Trial period duration in days, counted from the subscription start.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required for Onerway-managed subscriptions
                            (`selfExecute=1`) when a trial length is configured
                            by days.
                        x-onerway-constraints:
                          - kind: range
                            min: 3
                            max: 365
                            unit: days
                          - kind: consistency
                            text: Supported for Onerway-managed subscriptions and mutually exclusive with
                              `trialEnd`.
                          - kind: unsupported
                            text: Not supported for `selfExecute=2`.
                      trialEnd:
                        type: string
                        description: Trial period end date used to specify when the trial period ends.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required for Onerway-managed subscriptions
                            (`selfExecute=1`) when a trial end date is
                            configured.
                        x-onerway-constraints:
                          - kind: consistency
                            text: Supported for Onerway-managed subscriptions and mutually exclusive with
                              `trialDays`.
                          - kind: unsupported
                            text: Not supported for `selfExecute=2`.
                      notificationEmail:
                        type: string
                        description: Buyer email address used for subscription confirmation,
                          status-change, and billing notifications.
                        x-onerway-constraints:
                          - kind: unsupported
                            text: Not supported for `selfExecute=2`.
                      metaData:
                        type: string
                        description: Custom data for the subscription. Must be a string containing valid
                          JSON.
                        x-onerway-constraints:
                          - kind: consistency
                            text: If both top-level `metaData` and `subscription.metaData` are submitted,
                              `subscription.metaData` takes precedence.
                    required:
                      - requestType
                      - merchantCustId
                      - selfExecute
                  x-onerway-required: conditional
                  x-onerway-condition:
                    - Required when `subProductType=SUBSCRIBE`.
                  x-onerway-format: json_string
                txnOrderMsg:
                  type: string
                  description: Transaction business information, including `returnUrl`,
                    `notifyUrl`, `appId`, and product details. Browser, device,
                    and cardholder IP data are collected by the hosted checkout
                    page and are not submitted by the merchant in this request.
                  contentMediaType: application/json
                  contentSchema:
                    type: object
                    properties:
                      returnUrl:
                        type: string
                        description: Synchronous return URL used to redirect the customer after payment.
                          Add the merchant order ID or another identifier to the
                          URL and query the transaction result after the
                          customer returns.
                      products:
                        type: string
                        description: List of products purchased by the customer. Product amount,
                          discount, and shipping fee entries must add up to
                          `orderAmount`.
                        contentMediaType: application/json
                        contentSchema:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                description: Product name.
                              price:
                                type: string
                                description: Product unit price.
                              num:
                                type: string
                                description: Product quantity.
                              currency:
                                type: string
                                description: Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)
                                  currency code.
                              productAvatarUrl:
                                type: string
                                description: Product image URL.
                                x-onerway-required: conditional
                                x-onerway-condition:
                                  - Required when `lpmsType` is `stcpay`,
                                    `tamara`, `tabby`, or `cardpay`.
                              desc:
                                type: string
                                description: Product description.
                              type:
                                type: string
                                description: Product category. Omit this field for regular products. `virtual`
                                  and `physical` distinguish whether fulfillment
                                  is required; `shipping_fee` and `discount` can
                                  be used for all payment methods.
                                enum:
                                  - virtual
                                  - physical
                                  - shipping_fee
                                  - discount
                                x-enum-descriptions:
                                  virtual: Virtual product.
                                  physical: Physical product.
                                  shipping_fee: Shipping fee line item.
                                  discount: Discount line item. The amount must be negative.
                                x-onerway-required: conditional
                                x-onerway-condition:
                                  - Required when `lpmsType` is `stcpay`,
                                    `tamara`, `tabby`, or `cardpay`; use
                                    `virtual` or `physical` for product lines
                                    that those methods must categorize.
                              retailerId:
                                type: string
                                description: Identifier of the retailer that sells this product.
                                x-onerway-required: conditional
                                x-onerway-condition:
                                  - Required when `retailers` is submitted.
                                x-onerway-constraints:
                                  - kind: consistency
                                    text: The value must match one of the `retailerId` values submitted in
                                      `retailers`.
                                x-onerway-lifecycle:
                                  status: new
                                  since: 2026-08-10
                                  description:
                                    en: New field linking each product to its retailer.
                                    zh: 将商品关联到零售商的新增字段。
                            required:
                              - name
                              - price
                              - num
                              - currency
                        x-onerway-format: json_string
                      appId:
                        type: string
                        description: Store ID generated during Onerway onboarding.
                      customerPlatform:
                        type: string
                        description: Merchant platform identifier. Use the website domain for web
                          transactions or the app name for app transactions.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when `lpmsType` is `stcpay`, `tamara`,
                            `tabby`, or `cardpay`.
                      periodValue:
                        type: string
                        description: Installment payment period returned by the installment consultation
                          API.
                        x-onerway-required: conditional
                        x-onerway-condition:
                          - Required when top-level `subProductType=INSTALLMENT`.
                      notifyUrl:
                        type: string
                        description: Server-side notification URL for asynchronous payment result
                          callbacks. Merchants are advised to query the
                          transaction result after receiving the webhook
                          notification.
                    required:
                      - returnUrl
                      - products
                      - appId
                      - notifyUrl
                  x-onerway-format: json_string
                txnType:
                  type: string
                  description: Transaction operation type. It works together with `productType`
                    and `subProductType` to define the transaction model and is
                    also returned in transaction queries and asynchronous
                    notifications.
                  enum:
                    - SALE
                    - AUTH
                  x-enum-descriptions:
                    SALE: Debit-style transaction. Together with `subProductType=DIRECT`,
                      `SUBSCRIBE`, or `INSTALLMENT`, it is used for ordinary
                      payment, initial subscription, or installment payment.
                    AUTH: Authorization-style transaction. Funds are authorized first and not
                      captured immediately. It is usually used for card payment
                      scenarios that support authorization; availability depends
                      on the selected `productType`, `subProductType`, and the
                      merchant's enabled configuration.
              required:
                - billingInformation
                - merchantNo
                - merchantTxnId
                - orderAmount
                - orderCurrency
                - productType
                - shippingInformation
                - sign
                - subProductType
                - txnOrderMsg
                - txnType
            examples:
              one-time-card:
                summary: Card-only checkout
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  merchantCustId: custId_1784021156
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: card-4f71d2ae-4d0b-4fc2-8f2c-e450cf735baf
                  merchantTxnTime: 2025-08-21 10:17:31
                  orderAmount: "1"
                  orderCurrency: USD
                  productType: CARD
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: 4ee2d1398368a3cad281e97614fc134418922400f61a34c1fc1e81eca40002ba
                  subProductType: DIRECT
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"test
                    product\",\"num\":\"1\",\"price\":\"1\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
              one-time-all-methods:
                summary: Unified Checkout with all available payment methods
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  merchantCustId: custId_1784021159
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: all-711c89ac-304e-41b8-b92c-326270db9eaa
                  merchantTxnTime: 2025-08-21 10:17:31
                  orderAmount: "1"
                  orderCurrency: USD
                  productType: ALL
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: a5b63beb2778c887dd7429fe841c1d6ed3d04c207f21036b091d10157cd33843
                  subProductType: DIRECT
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"test
                    product\",\"num\":\"1\",\"price\":\"1\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
              one-time-google-pay:
                summary: Unified Checkout showing only Google Pay
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  lpmsInfo: '{"lpmsType":"GooglePay"}'
                  merchantCustId: custId_1784021162
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: googlepay-f914bb0e-f7f9-42ba-8268-18159b8f7ee9
                  merchantTxnTime: 2025-08-21 10:17:31
                  orderAmount: "100"
                  orderCurrency: USD
                  productType: ALL
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: 220e3b9a0e59d037d5bb29002c53c734904eb223116d78caf39da44b9979e303
                  subProductType: DIRECT
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"test
                    product\",\"num\":\"1\",\"price\":\"100\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
              one-time-apple-pay:
                summary: Unified Checkout showing only Apple Pay
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  lpmsInfo: '{"lpmsType":"ApplePay"}'
                  merchantCustId: custId_1784021162
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: applepay-0ebc4e9d-c0a8-4ea4-b58d-0b58822de562
                  merchantTxnTime: 2025-08-21 10:17:31
                  orderAmount: "1"
                  orderCurrency: USD
                  productType: ALL
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: 6eecfa0d03ec7d98d52ee27a907735de12d56e658c979fbcd9c4f90179597351
                  subProductType: DIRECT
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"test
                    product\",\"num\":\"1\",\"price\":\"1\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
              subscription:
                summary: Monthly card subscription with Onerway-managed billing
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  merchantCustId: cust_managed_001
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: managed-monthly-6db3a7cb-eb2d-48e0-8c60-c8501945c5df
                  merchantTxnTime: 2026-04-08 18:00:00
                  orderAmount: "20"
                  orderCurrency: USD
                  productType: CARD
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: 9d9ac005ee7801013cfe5894029f77ebebd7c83584eca581951626e8244416fd
                  subProductType: SUBSCRIBE
                  subscription: '{"requestType":"0","merchantCustId":"cust_managed_001","productName":"Managed
                    Plan -
                    Monthly","frequencyType":"M","frequencyPoint":"1","cycleCount":12,"mode":"2","selfExecute":"1","notificationEmail":"customer@test.com","metaData":"{\"plan\":\"pro-monthly\"}"}'
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"Managed
                    Subscription
                    Plan\",\"num\":\"1\",\"price\":\"20\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
              all-methods-monthly-subscription:
                summary: Monthly Unified Checkout subscription with Onerway-managed billing
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  merchantCustId: cust_all_managed_001
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: all-managed-monthly-35ec60d7-5b40-425b-a18b-bcdf5fff7f65
                  merchantTxnTime: 2026-04-09 10:00:00
                  orderAmount: "20"
                  orderCurrency: USD
                  productType: ALL
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: 13baa9bbfa5bd0b29063a559a9fc9b88aec0cb0560fde1ea362a36ee8d64bdb1
                  subProductType: SUBSCRIBE
                  subscription: '{"requestType":"0","merchantCustId":"cust_all_managed_001","productName":"All-Managed
                    Plan -
                    Monthly","frequencyType":"M","frequencyPoint":"1","cycleCount":12,"selfExecute":"1","mode":"2","notificationEmail":"customer@test.com","metaData":"{\"plan\":\"all-pro-monthly\"}"}'
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"Managed
                    Subscription
                    Plan\",\"num\":\"1\",\"price\":\"20\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
              apple-pay-daily-subscription:
                summary: Apple Pay subscription with multi-cycle discount
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  lpmsInfo: '{"lpmsType":"ApplePay"}'
                  merchantCustId: custId_1745215352000
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: self-managed-daily-2a4f2b18-d342-4fd9-98f7-819b4a292de4
                  merchantTxnTime: 2025-04-21 14:02:32
                  orderAmount: "20"
                  orderCurrency: USD
                  productType: ALL
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: replace_with_calculated_signature
                  subProductType: SUBSCRIBE
                  subscription: '{"requestType":"0","merchantCustId":"custId_1745215352000","productName":"Self-managed-30days-Once
                    daily","amountOff":"5.00","amountOffCycleCount":3,"frequencyType":"D","frequencyPoint":"1","expireDate":"2099-01-01","selfExecute":"2","mode":"2"}'
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"Subscription
                    Product\",\"num\":\"1\",\"price\":\"20\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
              pre-authorization:
                summary: Pre-authorize a card payment with Checkout
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  merchantCustId: CustId-D3AA-8022
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: 62243ffa-b8e6-4d78-8684-b538f5dbb379
                  merchantTxnTime: 2025-08-21 10:17:31
                  orderAmount: "1"
                  orderCurrency: USD
                  productType: ALL
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: bc16c76eb8d747f62f024b63ae682d60bba03d58f9cd3c828bdda9bdbb568779
                  subProductType: DIRECT
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"test
                    product\",\"num\":\"1\",\"price\":\"1\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: AUTH
              marketplace-retailers:
                summary: Marketplace checkout with multiple retailers
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: mkt-8f1c2d4e-6b70-4a19-9c53-1e7a0d5b2f38
                  merchantTxnTime: 2025-08-21 10:17:31
                  orderAmount: "150.00"
                  orderCurrency: USD
                  productType: ALL
                  retailers: '[{"retailerId":"RTL_100001","retailerName":"ABC Retail
                    Limited","retailerCountry":"GB"},{"retailerId":"RTL_100002","retailerName":"XYZ
                    Store GmbH","retailerCountry":"DE"}]'
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: replace_with_calculated_signature
                  subProductType: DIRECT
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"Wireless
                    Headphones\",\"num\":\"2\",\"price\":\"50.00\",\"retailerId\":\"RTL_100001\"},{\"currency\":\"USD\",\"name\":\"Desk
                    Lamp\",\"num\":\"1\",\"price\":\"50.00\",\"retailerId\":\"RTL_100002\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
              automatic-profit-share:
                summary: Payment with automatic profit share notifications
                value:
                  billingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  cardInfo: '{"holderName":"Test Cardholder"}'
                  merchantCustId: example_customer_id
                  merchantNo: replace_with_merchant_no
                  merchantTxnId: example_automatic_profit_share_payment
                  merchantTxnTime: 2026-09-17 10:00:00
                  orderAmount: "1"
                  orderCurrency: USD
                  productType: CARD
                  shippingInformation: '{"country":"US","email":"customer@test.com","province":"CA"}'
                  sign: replace_with_calculated_signature
                  subProductType: DIRECT
                  txnOrderMsg: '{"appId":"replace_with_app_id","products":"[{\"currency\":\"USD\",\"name\":\"test
                    product\",\"num\":\"1\",\"price\":\"1\",\"type\":\"\"}]","returnUrl":"https://developers.onerway.com/example-return","notifyUrl":"https://developers.onerway.com/example-notify"}'
                  txnType: SALE
                  paymentMethodOptions: '{"share":{"profitShare":true,"profitShareRate":"10","profitShareNotifyUrl":"https://developers.onerway.com/example-profit-callback"}}'
      responses:
        "200":
          description: Card-only checkout session created
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: Response code; `20000` means the request was processed
                      successfully, other values are error codes. See [Response
                      codes](/payments/api-reference/response-codes).
                  respMsg:
                    type: string
                    description: Human-readable message for the response code.
                  data:
                    type: object
                    properties:
                      transactionId:
                        type: string
                        description: Transaction number generated by Onerway for tracking and querying.
                      paymentId:
                        type: string
                        description: Payment intent ID identifying this payment; currently one request
                          maps to one `paymentId`, one-to-one with
                          `transactionId`.
                      merchantTxnId:
                        type: string
                        description: Merchant payment order number, echoing the `merchantTxnId` from the
                          request.
                      merchantNo:
                        type: string
                        description: Merchant number assigned by Onerway, identifying the merchant
                          account.
                      responseTime:
                        type:
                          - string
                          - "null"
                        description: API response time in `yyyy-MM-dd HH:mm:ss` format.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value after the transaction is processed; empty at the checkout
                              session creation stage.
                            zh: 交易处理后才有值；会话创建阶段为空。
                      txnTime:
                        type:
                          - string
                          - "null"
                        description: Transaction completion time in `yyyy-MM-dd HH:mm:ss` format.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value after the transaction completes; empty at the checkout session
                              creation stage.
                            zh: 交易完成后才有值；会话创建阶段为空。
                      orderAmount:
                        type: string
                        description: Original order amount in the transaction currency. Returned as a
                          decimal string using the amount precision accepted for
                          the submitted `orderCurrency`.
                      orderCurrency:
                        type: string
                        description: Order currency, a three-letter [ISO
                          4217](https://en.wikipedia.org/wiki/ISO_4217) currency
                          code.
                      txnAmount:
                        type:
                          - string
                          - "null"
                        description: Legacy settlement amount field.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Deprecated field; no reliable settlement amount is available from the
                              checkout session creation response.
                            zh: 已弃用字段；收银台会话创建响应中不提供可靠到账金额。
                        deprecated: true
                        x-onerway-deprecated:
                          description:
                            en: Do not rely on this field for the settled amount. The actual settlement
                              amount is settled per settlement batch; refer to
                              the batch settlement details or report.
                            zh: 请勿依赖本字段判断到账金额。实际结算金额按结算批次结算，以对应批次的结算明细 / 结算报表为准。
                      txnCurrency:
                        type:
                          - string
                          - "null"
                        description: Legacy settlement currency field.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Deprecated field; no reliable settlement currency is available from the
                              checkout session creation response.
                            zh: 已弃用字段；收银台会话创建响应中不提供可靠结算币种。
                        deprecated: true
                        x-onerway-deprecated:
                          description:
                            en: Do not rely on this field for the settlement currency. The settlement
                              currency follows the settlement configuration
                              pre-agreed between the merchant and Onerway.
                            zh: 请勿依赖本字段判断结算币种。结算币种以商户与 Onerway 预先约定的结算配置为准。
                      txnTimeZone:
                        type:
                          - string
                          - "null"
                        description: Transaction time zone offset in `±HH:mm` format.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value after the transaction completes; empty at the checkout session
                              creation stage.
                            zh: 交易完成后才有值；会话创建阶段为空。
                      status:
                        type: string
                        description: Current transaction processing status; always `U` (unpaid) right
                          after the checkout session is created.
                        enum:
                          - S
                          - F
                          - P
                          - R
                          - N
                          - I
                          - U
                        x-enum-descriptions:
                          S: Successful transaction.
                          F: Failed transaction.
                          P: Transaction is processing.
                          R: Redirect is required to continue payment.
                          N: Transaction was canceled, including closure after timing out without payment.
                          I: Transaction is under review or approval.
                          U: Checkout transaction is unpaid or unfinished.
                      paymentStatus:
                        type: string
                        description: Payment-intent-level status. Currently one request maps to one
                          payment intent and `paymentStatus` stays consistent
                          with the transaction status; cross-attempt intent
                          state transitions are not yet supported. `U` right
                          after session creation.
                        enum:
                          - I
                          - U
                          - P
                          - R
                          - A
                          - O
                          - S
                          - N
                        x-enum-descriptions:
                          I: Initialized payment intent.
                          U: Payment intent is pending.
                          P: Payment intent is processing.
                          R: Payment intent requires redirect.
                          A: Payment intent is authorized.
                          O: Payment intent is open.
                          S: Payment intent succeeded.
                          N: Payment intent is closed. It timed out without a successful payment — either
                            no attempt was made or all attempts failed.
                      reason:
                        type:
                          - string
                          - "null"
                        description: Description of the failure reason for merchant troubleshooting and
                          customer messaging.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value when the transaction is declined or fails; empty when the
                              checkout session is created successfully.
                            zh: 交易被拒绝 / 失败时才有值；会话创建成功时为空。
                      redirectUrl:
                        type: string
                        description: Checkout page URL; the merchant should redirect the customer here
                          to complete the payment.
                      sign:
                        type: string
                        description: Response signature string; verifying the response signature is
                          currently not recommended for merchants.
                      contractId:
                        type:
                          - string
                          - "null"
                        description: Subscription contract ID identifying the subscription; a key
                          parameter for subsequent charges.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value after the initial subscription succeeds via asynchronous
                              notification or query, usually stored together
                              with `tokenId`; empty at checkout session
                              creation.
                            zh: 初始订阅成功后才有值（经异步通知 / 查询），通常与 `tokenId` 成对存储；会话创建时为空。
                      tokenId:
                        type:
                          - string
                          - "null"
                        description: Payment token generated from the buyer's payment information. It
                          may be a subscription token for subsequent charges or
                          a card tokenization token for token payments; the two
                          belong to different systems and must not be mixed.
                          Store securely per PCI requirements.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value after the initial subscription or card tokenization succeeds via
                              asynchronous notification or query; empty at
                              checkout session creation.
                            zh: 初始订阅成功或卡令牌化成功后才有值（经异步通知 / 查询）；会话创建时无值。
                      tokenization:
                        type:
                          - string
                          - "null"
                        description: Tokenization result returned when the checkout flow produces
                          tokenization data.
                        x-onerway-value:
                          nullable: true
                          when:
                            en: No tokenization result is available for the checkout session.
                            zh: 当前收银台会话没有可用的 tokenization 结果时返回 null。
                      eci:
                        type:
                          - string
                          - "null"
                        description: Electronic Commerce Indicator (ECI) marking the transaction
                          security level and liability shift.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value only for 3DS transactions.
                            zh: 3DS 交易才有值。
                      transactionOrderNo:
                        type:
                          - string
                          - "null"
                        description: Transaction order number assigned during downstream payment
                          processing.
                        x-onerway-value:
                          nullable: true
                          when:
                            en: No downstream transaction order number has been assigned at checkout session
                              creation.
                            zh: 收银台会话创建时尚未分配下游交易订单号时返回 null。
                      periodValue:
                        type:
                          - string
                          - "null"
                        description: Number of installment periods.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value only for installment transactions.
                            zh: 分期交易才有值。
                      lpmsType:
                        type:
                          - string
                          - "null"
                        description: Local payment method type used for this transaction.
                        enum:
                          - GooglePay
                          - ApplePay
                          - JdPay
                          - Alipay+
                          - WeChat
                          - AlipayHK
                          - AlipayCN
                          - Kakao_Pay
                          - Klarna
                          - Boleto
                          - BankTransfer
                          - Banrisul
                          - Bradesco
                          - Banco do Brasil
                          - Itau
                          - MercadoPago
                          - PIX
                          - Servipag
                          - Sencillito
                          - Webpay
                          - Multicaja
                          - Baloto
                          - EFT
                          - Efecty
                          - SPEI
                          - OXXO
                          - OXXOPAY
                          - PagoEfectivo
                          - safetypay-cash
                          - safetypay-online
                          - PayU
                          - Przelewy24
                          - Pagosnet
                          - SEPADD
                          - Sofort
                          - Giropay
                          - iDEAL
                          - Konbini
                          - PayEasy
                          - POLi
                          - Bancontact
                          - OVO
                          - MyBank
                          - Dragonpay
                          - Skrill
                          - eNETS
                          - PayseraWallet
                          - LithuanianBanks
                          - PaySafeCard
                          - Paysafecash
                          - Payconiq
                          - Trustly
                          - PAY_BY_BANK
                          - GCash
                          - GrabPay
                          - PayMaya
                          - ELEVEN
                          - GrabPay SG
                          - TrueMoney Wallet
                          - Rabbit_Line_pay
                          - PromptPay
                          - KRUNGSRI_ONLINE
                          - BUALUANG_IBANKING
                          - CITI_POINTS
                          - K_PLUS
                          - MCASH
                          - TOUCH_GO_EWALLET
                          - ShopeePay
                          - Boost
                          - BNI
                          - MANDIRI
                          - Maybank
                          - PERMATA
                          - BRI
                          - CIMB
                          - DANA
                          - QRIS
                          - AKULAKU
                          - Paypay
                          - LINE_Pay
                          - Merpay
                          - Rakuten_Pay
                          - BitCash
                          - Net_Cash
                          - WebMoney
                          - au
                          - SoftBank
                          - NTT_Docomo
                          - Paidy
                          - BLIK
                          - BLIK_SEAMLESS
                          - cardpay
                          - stcpay
                          - tamara
                          - tabby
                          - MB_WAY
                          - null
                        x-enum-descriptions:
                          GooglePay: Google Pay wallet payment method.
                          ApplePay: Apple Pay wallet payment method.
                          JdPay: JD Pay payment method.
                          Alipay+: Alipay+ payment method.
                          WeChat: WeChat Pay payment method.
                          AlipayHK: AlipayHK payment method.
                          AlipayCN: Alipay payment method in mainland China.
                          Kakao_Pay: Kakao Pay payment method.
                          Klarna: Klarna payment method.
                          Boleto: Boleto payment method.
                          BankTransfer: Bank transfer payment method.
                          Banrisul: Banrisul bank payment method.
                          Bradesco: Bradesco bank payment method.
                          Banco do Brasil: Banco do Brasil bank payment method.
                          Itau: Itaú bank payment method.
                          MercadoPago: Mercado Pago payment method.
                          PIX: PIX instant payment method.
                          Servipag: Servipag payment method.
                          Sencillito: Sencillito payment method.
                          Webpay: Webpay payment method.
                          Multicaja: Multicaja payment method.
                          Baloto: Baloto cash payment method.
                          EFT: Electronic funds transfer payment method.
                          Efecty: Efecty cash payment method.
                          SPEI: SPEI bank transfer payment method.
                          OXXO: OXXO cash voucher payment method.
                          OXXOPAY: OXXO Pay payment method.
                          PagoEfectivo: PagoEfectivo cash payment method.
                          safetypay-cash: SafetyPay Cash payment method.
                          safetypay-online: SafetyPay Online payment method.
                          PayU: PayU payment method.
                          Przelewy24: Przelewy24 payment method.
                          Pagosnet: Pagosnet payment method.
                          SEPADD: SEPA Direct Debit payment method.
                          Sofort: Sofort payment method.
                          Giropay: giropay payment method.
                          iDEAL: iDEAL payment method.
                          Konbini: Konbini convenience store payment method.
                          PayEasy: Pay-easy payment method.
                          POLi: POLi payment method.
                          Bancontact: Bancontact payment method.
                          OVO: OVO wallet payment method.
                          MyBank: MyBank payment method.
                          Dragonpay: Dragonpay payment method.
                          Skrill: Skrill payment method.
                          eNETS: eNETS payment method.
                          PayseraWallet: Paysera Wallet payment method.
                          LithuanianBanks: Lithuanian bank payment method.
                          PaySafeCard: paysafecard prepaid payment method.
                          Paysafecash: paysafecash payment method.
                          Payconiq: Payconiq payment method.
                          Trustly: Trustly payment method.
                          PAY_BY_BANK: Pay by Bank payment method.
                          GCash: GCash wallet payment method.
                          GrabPay: GrabPay wallet payment method.
                          PayMaya: Maya wallet payment method.
                          ELEVEN: 7-Eleven payment method.
                          GrabPay SG: GrabPay Singapore wallet payment method.
                          TrueMoney Wallet: TrueMoney Wallet payment method.
                          Rabbit_Line_pay: Rabbit LINE Pay payment method.
                          PromptPay: PromptPay payment method.
                          KRUNGSRI_ONLINE: Krungsri Online banking payment method.
                          BUALUANG_IBANKING: Bualuang iBanking payment method.
                          CITI_POINTS: Citi Rewards Points payment method.
                          K_PLUS: K PLUS payment method.
                          MCASH: MCash wallet payment method.
                          TOUCH_GO_EWALLET: Touch 'n Go eWallet payment method.
                          ShopeePay: ShopeePay wallet payment method.
                          Boost: Boost wallet payment method.
                          BNI: BNI virtual account payment method.
                          MANDIRI: Mandiri virtual account payment method.
                          Maybank: Maybank virtual account payment method.
                          PERMATA: Permata virtual account payment method.
                          BRI: BRI virtual account payment method.
                          CIMB: CIMB virtual account payment method.
                          DANA: DANA wallet payment method.
                          QRIS: QRIS payment method.
                          AKULAKU: Akulaku payment method.
                          Paypay: PayPay payment method.
                          LINE_Pay: LINE Pay payment method.
                          Merpay: Merpay payment method.
                          Rakuten_Pay: Rakuten Pay payment method.
                          BitCash: BitCash payment method.
                          Net_Cash: NetCash payment method.
                          WebMoney: WebMoney payment method.
                          au: au PAY payment method.
                          SoftBank: SoftBank carrier payment method.
                          NTT_Docomo: d払い (Docomo) carrier payment method.
                          Paidy: Paidy payment method.
                          BLIK: BLIK payment method.
                          BLIK_SEAMLESS: BLIK Seamless payment method.
                          cardpay: MADA payment method.
                          stcpay: stc pay payment method.
                          tamara: Tamara payment method.
                          tabby: Tabby payment method.
                          MB_WAY: MB Way payment method.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value only for local payment method transactions; empty at checkout
                              session creation.
                            zh: 使用本地支付方式的交易才有值；会话创建时为空。
                      qrCode:
                        type:
                          - string
                          - "null"
                        description: QR code value carrying the encoded payment information.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value only for QR-code-based payment methods; empty at checkout
                              session creation.
                            zh: 使用二维码的支付方式才有值；会话创建时为空。
                      subscriptionManageUrl:
                        type:
                          - string
                          - "null"
                        description: Subscription management URL where the buyer can view and manage
                          their subscription.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Has a value only in subscription scenarios.
                            zh: 订阅场景才有值。
                      subscriptionsManageUrl:
                        type:
                          - string
                          - "null"
                        description: Subscriptions list management URL for managing multiple
                          subscriptions. Distinct from `subscriptionManageUrl`
                          (singular), which manages a single subscription.
                        x-onerway-value:
                          nullable: true
                          empty: true
                          when:
                            en: Returned when the buyer subscribes to multiple products at the same time.
                            zh: 买家同时订阅多个产品时返回。
                      linkName:
                        type:
                          - string
                          - "null"
                        description: Display name of the payment link associated with the checkout
                          session.
                        x-onerway-value:
                          nullable: true
                          when:
                            en: The checkout session was not created from a named payment link.
                            zh: 收银台会话不是通过具名支付链接创建时返回 null。
                      itemName:
                        type:
                          - string
                          - "null"
                        description: Name of the goods or services associated with the payment-link
                          checkout session.
                        x-onerway-value:
                          nullable: true
                          when:
                            en: No payment-link item is associated with the checkout session.
                            zh: 当前收银台会话未关联支付链接商品时返回 null。
                    description: Business data object for the checkout session creation response.
              examples:
                one-time-card:
                  summary: Card-only checkout session created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076961389037359104"
                      merchantTxnId: card-4f71d2ae-4d0b-4fc2-8f2c-e450cf735baf
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "1.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076961389016387584"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/checkout?key=bb02fff76ddf4ea9b021e4cd738e13e3
                      sign: 3607ed6b158396e7a16574e2d62d5abb4b0157fa1e7321714438749488eb2f12
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: null
                      tokenization: null
                      linkName: null
                      itemName: null
                one-time-all-methods:
                  summary: Unified Checkout session created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076961398319353856"
                      merchantTxnId: all-711c89ac-304e-41b8-b92c-326270db9eaa
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "1.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076961398294188032"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/aggregate?key=83d94e672c1b4b3b89082f1079fb7bab
                      sign: 63cb5333a684d5a1d3e009df7451c3b1724fc316440a6d3ad7c8a3f0453d7787
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: null
                      tokenization: null
                      linkName: null
                      itemName: null
                one-time-google-pay:
                  summary: Google Pay-only checkout session created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076961406078816256"
                      merchantTxnId: googlepay-f914bb0e-f7f9-42ba-8268-18159b8f7ee9
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "100.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076961406070427648"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/aggregate?key=954b2e942818433d83c8d9e131051e2d&checkoutDetail=H4sIAAAAAAAAAK1W23LbNhD9lQ6fLYlkJJLyU2XJadVajsdS0qYdTwYkVxRiEGABULLG43%2FvArw7TvrSF41wsNz7nsWzQ4pinTqXjhf6YRS50TR4F0ZT1wvnvnPh5CCTA%2BH6VjiXkev67ryHkRzww0UMrCe5e%2BJWXyZExqAg59F%2B7k3j2IXRPtzPR1M%2FJqPID6KRF3mzeRztQ4D5UMGOWs2%2B6wcjNxx505%2B88NIPLl3vW7m%2FBEdZXjJ24WiEzoX5dLu4uXYssMhFybUJ0HXHrluBy1JK4MkZ4Y%2FbFWKqjO%2BkSMtE1wpW6%2Fvr5Q5vEiJTg635XjR2ThArqo3YQetCXU4mKeRijJ7IEzmPE5FP8MuYMkZ5tkhTCUqh8Ol0GmtQ2gjUmiutzw7lKTw16s3Fr0Qd2jOGy4FtaWZT2wldUd4%2F3pZ5DLJBjmSRJFXstcjx2PzNBdet%2BjOQ9qODYCnIurK%2FiQP%2FaSWg9vVKEj4wvzTa5bmBYsIfb8XgZPVUZ5p2d%2BpE93opUugLm3OV%2FCHWntF8cugjpIqvCrv%2FaX0x0IbFeOVvncEN0clhqyXRkA3u6oZooKI6Lo2c6LQokEeaWM9XoBJJC01FWxaqVNmVJEtyVWvtFVKeCy0ySfIGgYS2nUYYg9YFyI%2F38E%2BJLTRAVCG46oZAkuTRb72m%2FHc4b6FnEKE7cmaCpK%2BFJCVs2ER4c82thxjUVhNdm3lB0%2Fs9JJoeYUN5iW3tXL5z7XB9kNhCG5X1U49zYFpd5qTKzrOzp1LpfoMwMjwXh95kQ04ow5ZMSqUFMsDPvTkqhNKEDRqjGbk6w03dcdgdW8gj5Ynp8OXC9DbVXTW1hC7ffJALmgLXKDvMUEylPqzaxFw4X4v3r0P7Wty8FVzdj53nL5aIvmkiCSmVmOuPknV%2BEl0aTtlaRlSKZK1uJUqZwLIijR41Wlr23TCYB97UDVykey%2FwZ4FjLOhScqu%2FozSRqAGlkYIqSwWYO9bzBRuOK5IYj23puzlH9s8xZ8th%2FpMDJI%2Bi1BuMm2EMfz9X7FWRzi92b2CD9rj3jSsmMtHzISYKgukNgv0J7ngbbVAM3wtmuMUiz49Cz%2FVmgR9FneQrC8VgHywX96uLm7vNtrZ9RwyBtsmSgmO%2BUziKQqWUZOOYiRizJmF8Qm4XJzXmoCfiCBJ%2FC5B2Dka4SEYqjZ8mjQ8mgknqBThasRtHbhAkYRKmURBFwTSZkgD86XRc8OzH2cEuWta3JsHOYnP9J8KbxXZ3fW9CwcNqvV1%2B%2BHR9j38%2FrbcL5%2BHlodK5FRInYDb3L3BIgSHN8z3NSkn6PVnxae%2FivRE1xh56df%2FOPVVbYGCo1fns2GbOQA34oTKSJkmzvlugW931KqufA7a7sbjuPHBev1Fq9sUhxV7e9D%2B4Wt77q9tg9zlcbWa71UenFauzioXNUNq2LWVIK%2FwVq1TTW3U2PGlkAlIP88OP8vfdmDmclvWAfDNGb6TzP6pRb3Wkrqs3WHhPmILq%2Bo%2FmSVNjOOVrbniVGdMtbJZwHZAh8bh6Ejj1UKxzS0P%2F21SUuFxxPdu9tIO8YPh%2F4s1DN5zh89SNXHyqBuHMnxjjX%2FCa8i%2BJYEKOvxZmQt5gBXNbOXykcKofq1qWUAFLS25XukuORatSW7iSJaUW9zUtNxhwEjNoircTj1CLv1iC7Z4M9rBIzbOh3W%2FNMl1zDPdImH2Rz%2BfR%2FJ1pPQkY%2BQ9fxd813vGtBU397RS%2B%2FAsR3RC%2F%2BwsAAA%3D%3D
                      sign: 5ef84acb27f4fcdfcff73ba25fad6b921d1684b393da50bd7dfb1e4bbc294683
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: null
                      tokenization: null
                      linkName: null
                      itemName: null
                one-time-apple-pay:
                  summary: Apple Pay-only checkout session created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076961409027411968"
                      merchantTxnId: applepay-0ebc4e9d-c0a8-4ea4-b58d-0b58822de562
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "1.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076961409010634752"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/aggregate?key=f44bb646ec1d41b4a02cf340af5d0c99&checkoutDetail=H4sIAAAAAAAAAK1W32%2FjNgz%2BVw5%2BbhLHTWynT0vTHtatvSuaHoZtKA6yzCRqZcmT5KRB0f99lCz%2F6rW3l70EEUmTIvnxo14CUpZXeXAWTJMoSdMwncWnSToLp8kiCk6CAhTdEWG%2ByOAsDcMoXPRkpAD8cJkB71nePwvnD%2F1yKMlxFEJGZ7DIRzQk6WgGZDbK5mk%2BCvE3jaIc5nE0%2FP6eOcdRGMWjMBlNZ5%2BmyVkUn4Xv2P0lBdqKivOTwKDoWNpP18vry8AJloWshLH5jcOwFq0qpUDQIwq%2FrS9QpqvsVsm8osZ%2FfnF1d7m6Rw0lKreyK7GRTZQDZJoZa7YzptRnk0kOhRzjPdSBHMdUFhP8MmOcM7Fd5rkCrdH4cDiMDWhjDbzn2utLwEQOz417q%2FiV6F17xmQF8DXburp2RudM9I9fqiID1Uj2ZElpnbk32e%2Bbv4UUpnV%2FBNJ%2BtJM8B%2BXb%2BpvciU8XEvxdzxURg%2FAr610dG1FGxNMXOTg5P%2FWZ5Z1OH9jGrGQOfWN7ros%2FlLVnDE93fQmp86vT7n%2FqFQNv2Iw39%2FUVvCGG7tZGEQPbgc4DohGV9XFl7WTnRYPaM%2BpufgGaKlYaJtu2MK2rriVbWmjvtddIdSyN3CpSNBKgrEUa4RzaK0Cxv4N%2FKoTQQKJLKXQ3AorQp6i9NRO%2Fw3ENvYAouiVHLkn%2B1kgxwocgQs2lcDfEpNaGGB%2FmFUNvNkAN28MNExXCOjg7Dd1wfVUIoRu97Zce58BCXRWkrs5LsGFKmz5AOBmey11vrqEgjCMkaaWNxPn%2FpTdHpdSG8AEwmpHzFW76jsMeuEbumaAW4aulxTYzXTeNgq7eYlALloMwaDusUMaU2V20hTkJHsvPb1N7LK%2FfS87jsbv5qyOiH0CkIGcKa%2F1N8e6exFSWU9aOD7Um29a3lpWisKpJo0eMjpOjMIkX8XQWLsIomU2nizgNbARTKeH8d5QmqR5QGimZdlSAteO9uyDghCbU3ti1vptz5P4Ca7Ya1p%2FugD7Jytxg3hxz%2BPulZi%2B%2FS%2BzSQHz2qPdHDZdb2btBRjTEs2sU9ue3Y22MwDD5aZyms2geJlF4Gk%2Fj03k66yyHAcrBMri%2BvVmfrJZ3Fz70LbHs2VZKSYHFzmEvS50zsh1nXGZYMgXjAxK7POixADORe1D4W4JyQzDCLTLSefY8aa5gE5gkGaWQ0nyeUzILo3maZNk0XqR0kxJIEzJ%2BLGH70%2BIghFZeaasb5ExTGxtVe6aJBQyiEZQ1Ch5eH2pfa6kQ9%2FP09ARHEziSu9iwbaVIH4k1i%2FYUn62pjfLQ6%2FYHeqbXwMESavBn4CC8BT1ghTpITmmzsltBt7D9AvNPAIfp5jCuGzEuCT2WrhTDd4onYZxVhPRNz8NA4Qv6sVO6Yxz5Rbyhl3qMa4jDs0FKIH6qH35W0g%2FLIOCw8pPywzy9U%2BH%2FaJBf78hh5%2B%2FQ8YZwDbX6j%2BZt42U47lfCEiy3oVux3cY%2BIcvmWf02CPyAXBWOj%2F63Calwy%2BKedgvqHoqS4%2F%2FJdJGEyRwfqWEa4oM1TubRxAb%2FjmomvlPJpcJpscPyDkFYbX3hPYODf7IaVUEtWDmWOzddcZy0brUT17akMvLO83MjA0EyDk3z7uUTePNXx7Td28Edlrl9P7SLrtmqVwLT3RPu3uWLRRJNLfQUYOY%2FfRx%2FGLwjXie0%2FXeD%2Bfov84r8zgEMAAA%3D
                      sign: 7827ec370f90f8e572fc8bba98094c544cf79018b5bc5c5ebb6441b67fccdf0e
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: null
                      tokenization: null
                      linkName: null
                      itemName: null
                subscription:
                  summary: Onerway-managed monthly card subscription created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076964432134934528"
                      merchantTxnId: managed-monthly-6db3a7cb-eb2d-48e0-8c60-c8501945c5df
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "20.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076964432118157312"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/checkout?key=db80f63868ea4c77bf849ff68f41f507
                      sign: 2ad480ce322aac1388885c1dd304e574b063449ac31d2ba00b3ad85c7259faaf
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: https://sandbox-myscribe.onerway.com/pages/subscription-list/details?subKey=1BnKnUKVXhc1PWa
                      tokenization: null
                      linkName: null
                      itemName: null
                all-methods-monthly-subscription:
                  summary: Onerway-managed monthly Unified Checkout subscription created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076964836763635712"
                      merchantTxnId: all-managed-monthly-35ec60d7-5b40-425b-a18b-bcdf5fff7f65
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "20.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076964836751052800"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/aggregate?key=95d018b40db04a8f91ee148d77cf0b79
                      sign: ba0ac1e3eb1bad688eb167995b02c86b311c3398a46d84fb6abf7496a542317f
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: https://sandbox-myscribe.onerway.com/pages/subscription-list/details?subKey=1BnKnUKVepFb0s4
                      tokenization: null
                      linkName: null
                      itemName: null
                apple-pay-daily-subscription:
                  summary: Merchant-managed daily Apple Pay subscription created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076965246048014336"
                      merchantTxnId: self-managed-daily-2a4f2b18-d342-4fd9-98f7-819b4a292de4
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "20.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076965246022848512"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/aggregate?key=4c376d59099b4b02bbe8e1acc6a257f7
                      sign: 7b3d9ffdbc551c9430d14a37a48fa12d15bd7be2ca60ac9318bd3c046bb5317c
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: null
                      tokenization: null
                      linkName: null
                      itemName: null
                pre-authorization:
                  summary: Card payment pre-authorization created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076966571951394816"
                      merchantTxnId: 62243ffa-b8e6-4d78-8684-b538f5dbb379
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "1.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076966571943006208"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/aggregate?key=6523c581d82b498ebc80be8bf1269dee
                      sign: dfb51272c66a3edd0bb6afe1470e39d746239d11bf7ed441adf9a3be8535a215
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: null
                      tokenization: null
                      linkName: null
                      itemName: null
                marketplace-retailers:
                  summary: Marketplace checkout session created
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      transactionId: "2076966571951394817"
                      merchantTxnId: mkt-8f1c2d4e-6b70-4a19-9c53-1e7a0d5b2f38
                      merchantNo: replace_with_merchant_no
                      responseTime: ""
                      txnTime: ""
                      orderAmount: "150.00"
                      orderCurrency: USD
                      txnAmount: ""
                      txnCurrency: null
                      txnTimeZone: null
                      status: U
                      paymentId: "2076966571943006209"
                      paymentStatus: U
                      reason: null
                      redirectUrl: https://sandbox-checkout.onerway.com/aggregate?key=8f1c2d4e6b704a199c531e7a0d5b2f38
                      sign: replace_with_calculated_signature
                      contractId: ""
                      tokenId: null
                      eci: null
                      transactionOrderNo: null
                      periodValue: null
                      lpmsType: null
                      qrCode: null
                      subscriptionManageUrl: null
                      tokenization: null
                      linkName: null
                      itemName: null
```
