Skip to main content
POST
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

Headers

X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform application

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
required

HMAC-SHA256 signature, used to verify request legitimacy

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

Example:

"1672905655498"

X-GatePay-Nonce
string
required

Random number, used to prevent replay attacks

Example:

"9578"

X-GatePay-On-Behalf-Of
string
required

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.

Body

application/json

Create product request parameters

merchantProductNo
string
required

Product code (merchant side unique identifier)

Example:

"MPROD_20240312_001"

productName
string
required

Product name

Example:

"Premium Membership Subscription"

priceList
object[]
required

Price list

Minimum array length: 1
productDesc
string

Product description

Example:

"Annual Premium Membership Service"

Product image URL

Example:

"https://www.example.com/images/product_logo.png"

Response

200 - application/json

Create product successful

code
string

Response code, 0 for success

Example:

"0"

message
string

Return error reason on failure

Example:

""

success
string

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

Example:

"true"

data
object

Product information