Products
Products
Steps:
- List all products
- Create new product with destination type "SHOP", if needed
- Place product order
- Check available product capabilities
- Create bank account request or card request
CreateProductsDto API Usage Guide
Prerequisites
- list all available currencies and select one
The CreateProductsDto object defines the structure for creating a product. Below are the details of each property that should be included when making a request to the API.
Request Body Schema
| Property | Type | Required | Description | Comments |
|---|---|---|---|---|
| name | string | Yes | The name of the product. | Example: "Card" |
| displayName | string | Yes | The name of the product used for display purposes. | Example: "Card" |
| category | enum | Yes | The product category. Options are: CARD, ACCOUNT or BUNDLE. Use BUNDLE for a package of products. | Example: "CARD" |
| productType | enum, mapped type | Yes | Represents a mapping from product category enum to one of the product type enums: ProductAccountTypeEnum, ProductCardTypeEnum, ProductBundleTypeEnum. The product type is validated dynamically based on the selected category. | |
| price | string | Yes | The price of the product. | Example: "100" |
supply (string, required)
Description: The available supply of the product.
Example: "10000"
url (string, optional)
Description: The URL of the product (if applicable).
Example: "https://example.com"
currency (object, required)
Description: The primary currency of the product.
Type: Currency
allowedCurrencies (array of objects, optional)
Description: A list of currencies allowed for this product.
Type: Currency[]
metadata (object, required)
Description: Metadata related to the product, such as additional configurations or attributes.
Type: ProductMetadata
active (boolean, required)
Description: Indicates whether the product is active.
Example: true
bundle (array of objects, optional)
Description: Specifies bundles associated with the product. Each bundle is represented using CreateProductBundleDto.
Type: CreateProductBundleDto[]
isCore (boolean, required)
Description: Indicates if the product is a core product. Always set this to false.
Example: false
destinationType (enum, required)
Description: Specifies the destination type of the product. Options are:
SHOP (Use this for products displayed for consumers).
Example: "SHOP"
refundable (boolean, optional)
Description: Indicates if the product is refundable.
Example: false
subscription (object, optional)
Description: Specifies subscription details associated with the product.
Type: ProductSubscription
Here's content that's only inside the second Tab.
Here's content that's only inside the third Tab.
Updated over 1 year ago