API de Integração
Vendas

Criar venda exclusiva

Cria uma venda exclusiva para um CPF a partir de cursos e turmas já cadastrados (IDs do PrincipiaPay). Obrigatórios: `cpf`, `checkout_price_in_cents` e `courses` (cada item com `id` e `courseClassId`, uma turma por curso). Com `campaign_id`, preço, cursos e prazos vêm da campanha e `courses` e `checkout_price_in_cents` deixam de ser obrigatórios. O preço total deve ser menor ou igual à soma dos preços das turmas. A entrada, se informada, precisa ser menor que o preço e não pode ser menor que a entrada padrão do curso (ou do parceiro, se o curso não tiver). Com mais de um curso, vale a maior entrada. Para novas integrações, prefira **Criar checkout (venda)**, que cadastra produtos e variações pelos seus SKUs.

POST
/sales/exclusive-sale

Autorização

apiToken
Api-Token<token>

Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.

Local: header

Corpo da Requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da Resposta

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sales/exclusive-sale" \  -H "Content-Type: application/json" \  -d '{    "cpf": "48096807544",    "checkout_price_in_cents": 150000,    "courses": [      {        "id": 251179,        "courseClassId": 44099      }    ],    "upfront_amount_in_cents": 15000,    "running_days_to_first_installment": 3,    "running_days_to_expire": 3,    "maxInstallmentsToApply": 12,    "consultant_id": "consultor@suaempresa.com.br",    "full_name": "Maria Silva",    "email": "maria.silva@email.com",    "phone": "11912341234"  }'
{  "content": {    "id": 1582050,    "cpf": "48096807544",    "fullName": "Maria Silva",    "webhook": "not_logged",    "redirect_url": "https://pay.principia.net/checkout/sua-empresa?classes=44099",    "checkout_price_in_cents": 150000,    "running_days_to_first_installment": 3,    "running_days_to_expire": 3,    "courses": [      {        "id": 251179,        "name": "Nome do curso",        "price": 200000,        "modality": "remote",        "isFullTime": false,        "courseClassIds": [          44099        ],        "courseSKU": "curso-sku-123"      }    ],    "snapshot": {      "status": "not_logged",      "basic_info_status": "incomplete",      "document_status": "incomplete",      "guarantor_status": "unneeded",      "signed_date": null,      "first_installment_paid_date": null    },    "logs": [      {        "webhook": "not_logged",        "createdAt": "2026-09-29"      }    ],    "consultant_id": "consultor@suaempresa.com.br",    "creator": "PARTNER_SYSTEM",    "version": 2,    "maxInstallmentsToApply": 12,    "createdAt": "2026-09-29",    "updatedAt": "2026-09-29"  }}

Listar filtros de vendas

Lista os filtros e valores aceitos na listagem de vendas. O campo `campaign` sempre vem vazio: para filtrar por campanha, use os nomes de **Listar campanhas**.

Consultar venda exclusiva

Consulta uma venda exclusiva pelo ID. Vendas comuns não aparecem aqui: se o ID for de uma venda comum, a resposta é 400. Para essas, use **Listar vendas** filtrando pelo ID.