v1

latestOpenAPI 3.1.0MIT2026-07-211323.1 KB

Create Product

Create product

post/merchant/open/v1/pay/merchant/product/create

Headers

X-GatePay-Certificate-ClientIdstring required

Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

Merchant client ID, obtained from GatePay platform application

X-GatePay-Signaturestring required

Example:672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77

HMAC-SHA256 signature, used to verify request legitimacy

X-GatePay-Timestampstring required

Example:1672905655498

Timestamp (milliseconds), time difference with server cannot exceed 5 minutes

X-GatePay-Noncestring required

Example:9578

Random number, used to prevent replay attacks

Request body

merchantProductNostring required

Product code (merchant side unique identifier)

productNamestring required

Product name

productDescstring

Product description

productLogostring

Product image URL

Example request

{
  "merchantProductNo": "MPROD_20240312_001",
  "productName": "Premium Membership Subscription",
  "productDesc": "Annual Premium Membership Service",
  "productLogo": "https://www.example.com/images/product_logo.png",
  "priceList": [
    {
      "merchantPriceNo": "MPRICE_20240312_001",
      "priceName": "Annual Subscription",
      "priceDesc": "Annual automatic deduction",
      "priceType": "FIX_AMOUNT",
      "payChannels": [
        {
          "channel": "GATEPAY",
          "status": "ACTIVE"
        }
      ],
      "amountType": "crypto",
      "cryptoCurrency": "USDT",
      "cryptoAmount": 99.99,
      "fiatCurrency": "USD",
      "fiatAmount": 99.99,
      "period": "YEAR",
      "interval": 1,
      "promoConfigType": "NONE",
      "promoAmount": 10,
      "promoRate": 0.8
    }
  ]
}

Response

Create product successful

codestring

Response code, 0 for success

messagestring

Return error reason on failure

successstring

Whether successful: true (success) / false (failure)

Example response

{
  "code": "0",
  "success": "true",
  "data": {
    "merchantProductNo": "MPROD_20240312_001",
    "productNo": "SPROD_10000001",
    "merchantId": 10001,
    "productName": "Premium Membership Subscription",
    "productDesc": "Annual Premium Membership Service",
    "productLogo": "https://www.example.com/images/product_logo.png",
    "createTime": 1710230400000,
    "updateTime": 1710230500000,
    "priceList": [
      {
        "merchantPriceNo": "MPRICE_20240312_001",
        "priceNo": "SPRICE_10000001",
        "productNo": "SPROD_10000001",
        "priceName": "Annual Subscription",
        "priceDesc": "Annual automatic deduction",
        "priceType": "FIX_AMOUNT",
        "payChannels": [
          {
            "channel": "GATEPAY",
            "status": "ACTIVE"
          }
        ],
        "amountType": "CRYPTO",
        "cryptoCurrency": "USDT",
        "cryptoAmount": 99.99,
        "fiatCurrency": "USD",
        "fiatAmount": 99.99,
        "exchangeRate": 6.85,
        "period": "YEAR",
        "interval": 1,
        "promoConfigType": "NONE",
        "promoAmount": 10,
        "promoRate": 0.1,
        "createTime": 1710230400000,
        "updateTime": 1710230500000
      }
    ]
  }
}

All 1 operations