Skip to main content
POST
Create a product

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Headers

X-Idempotency-Key
string
required

A unique string to ensure the request is processed only once. Must be unique per request. Valid for 24 hours.

Maximum string length: 100

Body

application/json
name
string
required

Product name.

Required string length: 1 - 200
externalId
string

Your own product ID.

Maximum string length: 100
description
string

Product description.

Maximum string length: 1000
amount
number

Default price.

Required range: 0.01 <= x <= 1000000
metadata
object

Response

Product created.

product
object