products

Create a product

Creates a reusable product (fixed-price checkout template with a public page). Requires scope merchant_write on the API-key path. sk_test_ creates sandbox products.

post/api/products

Request

  • Base URL: https://api.depixapp.com
  • URL: https://api.depixapp.com/api/products
  • Auth: HTTP bearer

Request body

namestring required

Product name (2–80 chars).

slugstring

URL slug (lowercase letters, digits, hyphens). Auto-generated from name when omitted.

amountinteger required

Price in cents (BRL). Range: 500–600000.

descriptionstring

Product description (max 500 chars).

image_urlstring

HTTPS product image URL.

callback_urlstring

HTTPS webhook endpoint for checkouts created from this product.

redirect_urlstring

HTTPS post-payment redirect for checkouts created from this product.

metadataobject

Arbitrary JSON copied into each checkout (max 4KB serialized).

expires_ininteger

Checkout QR lifetime in seconds. Range: 300–1200; default 1200.

kind'product' | 'charge'

Row kind: 'product' (catalog item, default) or 'charge' (cobrança — a configurable payment link with a due date and late fees, served at pay.depixapp.com/c/{id} and never listed on any store surface).

due_datestring

Charges only (required for them): first due date, YYYY-MM-DD — the recurrence anchor.

recurrencestring nullable

Charges only: null (one-time) or weekly | monthly | quarterly | semiannual | yearly. Monthly-and-up anchor on the due day, clamping to shorter months.

late_fine_bpsinteger

Charges only: one-time late fine in basis points of the base (200 = 2%). Default 0.

late_interest_monthly_bpsinteger

Charges only: monthly interest in basis points, accrued pro-rata per day late (100 = 1% a.m.). Default 0.

Response

Product created.

Changes

No recorded changes to this operation across all 1 revision of this API.