Sign in

v1

latestOpenAPI 3.0.32026-07-2647114182.1 KB
payments

Cria uma cobrança transacional Pix ou Boleto vinculada a um produto e oferta da conta autenticada. O split entre produtor, coprodutores e afiliados é resolvido internamente pela Cakto.

post/public_api/payments/

Headers

X-Idempotency-Keystring required

Identificador único da cobrança (até 255 caracteres). Recomendado UUID v4. Reuso com payload idêntico devolve a resposta original por 24h.

Request body

productIdstring required

short_id ou id (UUID) do produto. O produto deve pertencer ao tenant autenticado e estar ativo.

paymentMethod'pix' | 'pix_auto' | 'boleto' required

Método de pagamento da cobrança.

affiliateShortIdstring

short_id do afiliado responsável pela venda. Deve estar com status active e cadastrado para o produto informado.

couponstring

Código do cupom de desconto.

dueDatestring date

Somente para boleto. Data de vencimento (YYYY-MM-DD). Deve ser futura e respeitar o ticketExpiration do produto.

pixExpiresIninteger

Somente para pix e pix_auto. Expiração do código Pix em segundos. Mínimo 60. Deve respeitar o pixExpiresIn do produto.

Response

Cobrança criada com sucesso.

idstring

Identificador único do pedido criado.

refIdstring

Código curto de referência do pedido.

statusstring

Status inicial do pedido. Para Pix e Boleto, normalmente waiting_payment.

paymentMethod'pix' | 'pix_auto' | 'boleto'
amountstring

Valor final cobrado, em reais, como string decimal.

baseAmountstring nullable
discountstring nullable
feesstring nullable
externalIdstring nullable

Identificador da transação no provedor.

checkoutUrlstring nullable

URL do checkout Cakto.

createdAtstring date-time