> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Product

> Create product

## Overview

This page documents the `POST /merchant/open/institution/v1/pay/merchant/product/create` endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

## Notes

* Authentication uses the standard GatePay signed headers.
* This page documents the standard merchant endpoint.
* For shared signing rules, see [/api-reference/version/100/en/common/securityAndSignature](/api-reference/version/100/en/common/securityAndSignature).


## OpenAPI

````yaml /api-reference/version/100/en/openapi/institution/subscription/productCreate-openapi.json POST /merchant/open/institution/v1/pay/merchant/product/create
openapi: 3.1.0
info:
  title: GatePay API
  description: GatePay Payment Platform API Documentation
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://openplatform.gateapi.io
security: []
paths:
  /merchant/open/institution/v1/pay/merchant/product/create:
    post:
      summary: Create Product
      description: Create product
      parameters:
        - $ref: '#/components/parameters/X-GatePay-Certificate-ClientId'
        - $ref: '#/components/parameters/X-GatePay-Signature'
        - $ref: '#/components/parameters/X-GatePay-Timestamp'
        - $ref: '#/components/parameters/X-GatePay-Nonce'
        - $ref: '#/components/parameters/X-GatePay-On-Behalf-Of'
      requestBody:
        description: Create product request parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProductRequest'
            examples:
              basicExample:
                summary: Basic Example
                value:
                  merchantProductNo: MTDC123
                  productName: Meituan Bike
                  productDesc: Meituan Bike Membership
                  productLogo: >-
                    https://s3.ap-northeast-1.amazonaws.com/gimg.gateimg.com/image/1627288/fe48d444c1943d65fb0125d766a7124d277f52d7112eebe6df47e321bafda073.jpg
                  priceList:
                    - merchantPriceNo: MTDC_1123
                      priceName: Monthly Plan
                      priceDesc: Monthly
                      priceType: FIX_AMOUNT
                      amountType: fiat
                      cryptoCurrency: ''
                      cryptoAmount: null
                      fiatCurrency: USD
                      fiatAmount: 10
                      period: MONTH
                      interval: 1
                      promoConfigType: NONE
                      promoAmount: null
                      promoRate: null
        required: true
      responses:
        '200':
          description: Create product successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProductResponse'
              examples:
                successResponse:
                  summary: Success Response
                  value:
                    success: 'true'
                    code: '0'
                    message: ''
                    data:
                      merchantProductNo: MTDC123
                      productNo: '82973642140155927'
                      productName: Meituan Bike
                      productDesc: Meituan Bike Membership
                      productLogo: >-
                        https://s3.ap-northeast-1.amazonaws.com/gimg.gateimg.com/image/1627288/fe48d444c1943d65fb0125d766a7124d277f52d7112eebe6df47e321bafda073.jpg
                      status: ACTIVE
                      createTime: 1774853409437
                      updateTime: 1774853409437
                      priceList:
                        - merchantPriceNo: MTDC_1123
                          priceNo: '82973642140155928'
                          productNo: '82973642140155927'
                          priceName: Monthly Plan
                          priceDesc: Monthly
                          priceType: FIX_AMOUNT
                          payChannels:
                            - channel: GATEPAY
                              status: ACTIVE
                          amountType: fiat
                          cryptoCurrency: ''
                          cryptoAmount: null
                          fiatCurrency: USD
                          fiatAmount: 10
                          period: MONTH
                          interval: 1
                          promoConfigType: NONE
                          promoAmount: null
                          promoRate: null
                          status: ACTIVE
                          createTime: 1774853409437
                          updateTime: 1774853409437
components:
  parameters:
    X-GatePay-Certificate-ClientId:
      name: X-GatePay-Certificate-ClientId
      in: header
      required: true
      description: Merchant client ID, obtained from GatePay platform application
      schema:
        type: string
        example: 4186d0c6-6a35-55a9-8dc6-5312769dbff8
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: HMAC-SHA256 signature, used to verify request legitimacy
      schema:
        type: string
        example: >-
          672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: >-
        Timestamp (milliseconds), time difference with server cannot exceed 5
        minutes
      schema:
        type: string
        example: '1672905655498'
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: Random number, used to prevent replay attacks
      schema:
        type: string
        example: '9578'
    X-GatePay-On-Behalf-Of:
      name: X-GatePay-On-Behalf-Of
      in: header
      required: true
      schema:
        type: string
      description: >-
        Required delegated-subject header. Provide the initiating account ID for
        this request. For institution merchant APIs, this is typically the
        target sub-account ID; for institution charge and transfer APIs, it can
        be either an institution account ID or a sub-account ID.
  schemas:
    CreateProductRequest:
      type: object
      required:
        - merchantProductNo
        - productName
        - priceList
      properties:
        merchantProductNo:
          type: string
          description: Product code (merchant side unique identifier)
          example: MPROD_20240312_001
        productName:
          type: string
          description: Product name
          example: Premium Membership Subscription
        productDesc:
          type: string
          description: Product description
          example: Annual Premium Membership Service
        productLogo:
          type: string
          description: Product image URL
          example: https://www.example.com/images/product_logo.png
        priceList:
          type: array
          description: Price list
          minItems: 1
          items:
            type: object
            required:
              - merchantPriceNo
              - priceName
              - priceType
              - amountType
              - period
              - interval
              - promoConfigType
            properties:
              merchantPriceNo:
                type: string
                description: Price code (merchant side unique identifier)
                example: MPRICE_20240312_001
              priceName:
                type: string
                description: Price name
                example: Annual Subscription
              priceDesc:
                type: string
                description: Price description
                example: Annual automatic deduction
              priceType:
                type: string
                description: >-
                  Price model. FIX_AMOUNT: Fixed amount deduction, ACCOUNT_AUTH:
                  Account authorization payment (requires payChannels)
                enum:
                  - FIX_AMOUNT
                  - ACCOUNT_AUTH
                example: FIX_AMOUNT
              payChannels:
                type: array
                description: Payment channels (required when priceType=ACCOUNT_AUTH)
                items:
                  type: object
                  properties:
                    channel:
                      type: string
                      description: >-
                        Channel name. GATEPAY: GatePay payment channel, WEB3:
                        Web3 payment channel
                      enum:
                        - GATEPAY
                        - WEB3
                      example: GATEPAY
                    status:
                      type: string
                      description: >-
                        Channel status. ACTIVE: Available for use, INACTIVE: Not
                        available
                      enum:
                        - ACTIVE
                        - INACTIVE
                      example: ACTIVE
              amountType:
                type: string
                description: >-
                  Merchant pricing method. crypto: Cryptocurrency pricing, fiat:
                  Fiat currency pricing
                enum:
                  - crypto
                  - fiat
                example: crypto
              cryptoCurrency:
                type: string
                description: Currency type (required when amountType=crypto)
                example: USDT
              cryptoAmount:
                type: number
                format: double
                description: Amount (required when amountType=crypto)
                example: 99.99
              fiatCurrency:
                type: string
                description: Fiat currency type (required when amountType=fiat)
                example: USD
              fiatAmount:
                type: number
                format: double
                description: Fiat currency amount (required when amountType=fiat)
                example: 99.99
              period:
                type: string
                description: >-
                  Deduction period. DAY: Daily deduction, WEEK: Weekly
                  deduction, MONTH: Monthly deduction, YEAR: Annual deduction
                enum:
                  - DAY
                  - WEEK
                  - MONTH
                  - YEAR
                example: YEAR
              interval:
                type: integer
                minimum: 1
                description: >-
                  Deduction interval, default 1, can be combined with period
                  (e.g., every 2 weeks pass 2)
                example: 1
              promoConfigType:
                type: string
                description: >-
                  Special price type. NONE: No promotion, FIX_AMOUNT: Fixed
                  discount amount, RAET: Discount rate
                enum:
                  - NONE
                  - FIX_AMOUNT
                  - RAET
                example: NONE
              promoAmount:
                type: number
                format: double
                description: >-
                  First period discount amount (required when
                  promoConfigType=FIX_AMOUNT)
                example: 10
              promoRate:
                type: number
                format: double
                multipleOf: 0.01
                description: >-
                  First period discount rate (required when
                  promoConfigType=RAET, maximum 2 decimal places, e.g., 1
                  discount pass 0.1)
                example: 0.8
            allOf:
              - if:
                  properties:
                    amountType:
                      const: crypto
                then:
                  required:
                    - cryptoCurrency
                    - cryptoAmount
              - if:
                  properties:
                    amountType:
                      const: fiat
                then:
                  required:
                    - fiatCurrency
                    - fiatAmount
              - if:
                  properties:
                    promoConfigType:
                      const: FIX_AMOUNT
                then:
                  required:
                    - promoAmount
              - if:
                  properties:
                    promoConfigType:
                      const: RAET
                then:
                  required:
                    - promoRate
              - if:
                  properties:
                    priceType:
                      const: ACCOUNT_AUTH
                then:
                  required:
                    - payChannels
    CreateProductResponse:
      type: object
      properties:
        code:
          type: string
          description: Response code, 0 for success
          example: '0'
        message:
          type: string
          description: Return error reason on failure
          example: ''
        success:
          type: string
          description: 'Whether successful: true (success) / false (failure)'
          example: 'true'
        data:
          type: object
          description: Product information
          properties:
            merchantProductNo:
              type: string
              description: Product code
              example: MPROD_20240312_001
            productNo:
              type: string
              description: Product unique number
              example: SPROD_10000001
            merchantId:
              type: integer
              format: int64
              description: Merchant ID
              example: 10001
            productName:
              type: string
              description: Product name
              example: Premium Membership Subscription
            productDesc:
              type: string
              description: Product description
              example: Annual Premium Membership Service
            productLogo:
              type: string
              description: Product image
              example: https://www.example.com/images/product_logo.png
            createTime:
              type: integer
              format: int64
              description: Creation time (timestamp)
              example: 1710230400000
            updateTime:
              type: integer
              format: int64
              description: Update time (timestamp)
              example: 1710230500000
            priceList:
              type: array
              description: Price list
              items:
                type: object
                properties:
                  merchantPriceNo:
                    type: string
                    description: Price number
                    example: MPRICE_20240312_001
                  priceNo:
                    type: string
                    description: Price unique number
                    example: SPRICE_10000001
                  productNo:
                    type: string
                    description: Product unique number
                    example: SPROD_10000001
                  priceName:
                    type: string
                    description: Price name
                    example: Annual Subscription
                  priceDesc:
                    type: string
                    description: Price description
                    example: Annual automatic deduction
                  priceType:
                    type: string
                    description: >-
                      Price model. FIX_AMOUNT: Fixed amount deduction,
                      ACCOUNT_AUTH: Account authorization payment
                    enum:
                      - FIX_AMOUNT
                      - ACCOUNT_AUTH
                    example: FIX_AMOUNT
                  payChannels:
                    type: array
                    description: Payment channels
                    items:
                      type: object
                      properties:
                        channel:
                          type: string
                          description: >-
                            Channel name. GATEPAY: GatePay payment channel,
                            WEB3: Web3 payment channel
                          enum:
                            - GATEPAY
                            - WEB3
                          example: GATEPAY
                        status:
                          type: string
                          description: >-
                            Channel status. ACTIVE: Available, INACTIVE: Not
                            available
                          enum:
                            - ACTIVE
                            - INACTIVE
                          example: ACTIVE
                  amountType:
                    type: string
                    description: Merchant pricing method
                    example: CRYPTO
                  cryptoCurrency:
                    type: string
                    description: Currency
                    example: USDT
                  cryptoAmount:
                    type: number
                    format: double
                    description: Amount
                    example: 99.99
                  fiatCurrency:
                    type: string
                    description: Fiat currency
                    example: USD
                  fiatAmount:
                    type: number
                    format: double
                    description: Fiat amount
                    example: 99.99
                  exchangeRate:
                    type: number
                    format: double
                    description: Exchange rate
                    example: 6.85
                  period:
                    type: string
                    description: Billing period
                    example: YEAR
                  interval:
                    type: integer
                    description: Billing interval
                    example: 1
                  promoConfigType:
                    type: string
                    description: Promotion type
                    example: NONE
                  promoAmount:
                    type: number
                    format: double
                    description: >-
                      First period promotional amount (actual payment amount
                      after discount)
                    example: 10
                  promoRate:
                    type: number
                    format: double
                    description: First period promotional discount
                    example: 0.1
                  createTime:
                    type: integer
                    format: int64
                    description: Creation time (timestamp)
                    example: 1710230400000
                  updateTime:
                    type: integer
                    format: int64
                    description: Update time (timestamp)
                    example: 1710230500000

````