API v1
Começar

Cobrar um produto do catálogo

Cadastre o produto no painel e cobre pela API com o preço que está lá.

1. Cadastre o produto no painel

No painel, abra Produtos → Novo produto e informe nome, preço e, se quiser, um sku seu. O catálogo é gerenciado só pelo painel; pela API ele é somente leitura, com o escopo charges:read.

Assinaturas ainda não cobram. Por enquanto só produtos avulsos podem ser cobrados. Assinaturas aparecem no painel como em breve.

2. Consulte o catálogo

A lista traz apenas produtos ativos, do mais novo para o mais antigo. Use o id do produto e o price_cents atual na cobrança.

GET/v1/productsListar produtosGET/v1/products/{productId}Consultar produto

3. Crie a cobrança com o produto

Envie product_id junto com os campos de sempre. O amount_cents tem de ser igual ao price_cents atual do produto: a Mainum confere o preço na hora de criar, para que uma mudança de preço no painel nunca gere cobrança com valor antigo.

POST/v1/chargesCriar cobrança Pix

A cobrança criada, e o webhook charge.paid dela, trazem o mesmo product_id, para você saber o que foi vendido.

Se o produto não puder ser cobrado

A resposta é 422 com o erro product_unavailable; o campo reason diz o motivo:

reasonO que fazer
price_mismatchO preço mudou. Consulte o produto de novo e use o price_cents atual.
inactiveO produto foi desativado, arquivado ou é uma assinatura. Escolha outro produto.
not_foundNão há produto com esse ID nesta conta.