Products API — List, Create, and Retrieve Products

The Products API lets you list your product catalogue, import or create new products, fetch the details of a specific product, and retrieve the Pagar.me public key needed for client-side card tokenization. All endpoints are relative to the base URL https://yourcompany.pay.nova.money/api/v1.

List products

This endpoint requires an API key passed in the request headers.

Retrieve all products in your account. You can search by name and optionally include soft-deleted products.

GET /products

Query parameters

string

Free-text search string. Filters products by name.

boolean

When true, includes soft-deleted products in the response. Defaults to false.

Response — array of `ProductSummary`

integer

Unique numeric ID of the product.

string

Product display name.

string

Product type (e.g., digital, physical, service).

integer

ID of the company that owns this product.

number

Base price of the product.

boolean

Whether the product has been soft-deleted.

boolean

Whether the product is sold as a recurring subscription.

Example response

[
  {
    "id": 101,
    "name": "Annual Membership",
    "type": "digital",
    "company_id": 5,
    "value": 299.90,
    "deleted": false,
    "subscription": true
  },
  {
    "id": 102,
    "name": "Physical Kit",
    "type": "physical",
    "company_id": 5,
    "value": 89.90,
    "deleted": false,
    "subscription": false
  }
]

Create a product

This endpoint requires an API key passed in the request headers.

Import or create a new product in your Nova.Pay account. Use this to programmatically sync your product catalogue.

POST /products

Request body

string

required

Product display name.

number

required

Base price of the product in the account currency.

string

Brief description shown on checkout pages.

string

Tax-related description for invoice generation.

string

Label for the unit of sale (e.g., license, seat, box).

number

Product weight in grams. Required for physical products that use shipping calculation.

string

Nomenclatura Comum do Mercosul (NCM) code for fiscal classification of physical goods.

integer

ID of the company to assign this product to. Defaults to the authenticated account’s primary company.

integer

ID of the financial account to associate with this product for revenue tracking.

integer

ID of the tax configuration to apply to this product for invoice generation.

string

Your internal identifier for this product. Useful for syncing with external systems.

Response — `ProductCreateResponse`

integer

Unique numeric ID of the newly created product.

string

Product display name.

string

Full product description.

number

Base price of the product.

string

Tax-related description stored on the product.

string

NCM fiscal classification code.

object

Unit configuration for this product (includes name and related settings).

object

The company that owns this product (includes id and name).

object

Tax configuration applied to this product, if set.

object

Financial account associated with this product, if set.

Retrieve a product

Fetch the public details of a single product by its ID. This endpoint is public and does not require an API key, making it suitable for use directly from your frontend.

GET /products/{id}

Path parameters

integer

required

The numeric ID of the product to retrieve.

Response — `ProductShow`

integer

Unique numeric ID of the product.

string

Product display name.

string

Full product description.

boolean

Whether the product is sold as a recurring subscription.

number

Base price of the product.

number

Product weight in grams. Only present when a weight has been set.

string

URL of the product image. Only present when an image has been attached.

Complete JSON response

This example includes every response property defined for this operation in the OpenAPI schema.

{
  "id": 123,
  "name": "Example",
  "description": "string",
  "subscription": true,
  "value": 100.5,
  "weight": 123,
  "image": "https://example.com/resource"
}

Get Pagar.me public key

Retrieve the Pagar.me public key associated with this product. Use this key to initialize the Pagar.me.js client on your checkout page for secure client-side card tokenization — the raw card data never touches your server.

GET /products/{id}/pagarme_public_key

Path parameters

integer

required

The numeric ID of the product whose Pagar.me configuration you want to retrieve.

Response

string

The Pagar.me publishable key (prefixed pk_) for client-side tokenization.

Example response

{
  "public_key": "pk_live_abcdef1234567890"
}

Pass this public_key to PagarMe.client(publicKey) in your browser code to tokenize card details before submitting the payment form. Never send raw card numbers to your own server.

Checkout

Payments

Management

Webhooks

Products API — List, Create, and Retrieve Products

List products

Query parameters

Response — array of `ProductSummary`

Example response

Create a product

Request body

Response — `ProductCreateResponse`

Retrieve a product

Path parameters

Response — `ProductShow`

Complete JSON response

Get Pagar.me public key

Path parameters

Response

Example response

​List products

​Query parameters

​Response — array of ProductSummary

​Example response

​Create a product

​Request body

​Response — ProductCreateResponse

​Retrieve a product

​Path parameters

​Response — ProductShow

​Complete JSON response

​Get Pagar.me public key

​Path parameters

​Response

​Example response

List products

Query parameters

Response — array of `ProductSummary`

Example response

Create a product

Request body

Response — `ProductCreateResponse`

Retrieve a product

Path parameters

Response — `ProductShow`

Complete JSON response

Get Pagar.me public key

Path parameters

Response

Example response