API de Integração
Vendas

Listar vendas

Lista todas as vendas do parceiro, exclusivas ou não, com paginação. Para achar uma venda específica, filtre por `CreditRequestId`. Sem `CreditRequestId`, vendas com status `not_logged`, `canceled_by_partner` e `expired` não aparecem. Parâmetro com nome ou tipo errado é ignorado. Datas no formato `AAAA-MM-DD`; se só a data inicial for enviada, ela também vale como data final. Os filtros `status`, `cridOrigin`, `courseId`, `productType`, `creator` e `campaign` podem ser repetidos. Veja os valores aceitos em **Listar filtros de vendas**.

GET
/sales

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

Parâmetros de Query

page?string

Página (começa em 1).

limit?string

Itens por página.

CreditRequestId?string

ID da venda.

cpf?string

CPF do aluno (busca por trecho).

email?string

E-mail do aluno (busca por trecho).

name?string

Nome do aluno (busca por trecho).

status?array<string>

Situação da venda.

cridOrigin?array<string>

Origem da venda (ex.: CAMPAIGN, PROVI_PAY).

courseId?array<string>

ID do curso.

productType?array<string>

Tipo de produto.

creator?array<string>

Quem criou a venda (e-mail do consultor ou sistema).

campaign?array<string>

Nome da campanha.

campaignCustomIdentifier?string

Identificador próprio da campanha.

startDate?string

Criação da venda, data inicial.

endDate?string

Criação da venda, data final.

startEffectiveDate?string

Efetivação, data inicial.

endEffectiveDate?string

Efetivação, data final.

startReleasedDate?string

Liberação do curso, data inicial.

endReleasedDate?string

Liberação do curso, data final.

startExpectedPaymentDate?string

Repasse previsto, data inicial.

endExpectedPaymentDate?string

Repasse previsto, data final.

startTedDate?string

Repasse realizado (TED), data inicial.

endTedDate?string

Repasse realizado (TED), data final.

startNextPaymentDate?string

Próximo vencimento (vendas MaaS), data inicial.

endNextPaymentDate?string

Próximo vencimento (vendas MaaS), data final.

useNewStatusTranslation?boolean

true usa a nomenclatura nova de status.

Corpo da Resposta

application/json

application/json

curl -X GET "https://example.com/sales?page=1&limit=50&CreditRequestId=1582050&useNewStatusTranslation=false"
{  "paging": {    "itemsPerPage": 50,    "nextPage": null,    "currentPage": 1,    "previousPage": null,    "totalPages": 1,    "totalItems": 1  },  "metaData": {    "salesBySellers": []  },  "content": [    {      "id": 1582050,      "campaignName": null,      "campaignCustomIdentifier": null,      "createdAt": "2026-09-29",      "updatedAt": "2026-09-29",      "resumeStatus": "made_effective",      "CPF": "48096807544",      "email": "maria.silva@email.com",      "phone": "11912341234",      "fullName": "MARIA SILVA",      "origin": "PROVI_PAY",      "ProductType": "CourseFinancing",      "totalValue": 150000,      "upfrontValue": 15000,      "installmentsToApply": 12,      "madeEffectiveDate": "2026-09-30",      "courses": [],      "creator": "PARTNER_SYSTEM",      "isProviPay": true    }  ]}

Erros

Formatos de erro da API do PrincipiaPay e o que fazer em cada caso.

Criar checkout (venda)

Cria uma venda vinculada a um CPF e devolve a URL do checkout, para redirecionar o comprador ou embutir na sua página. Produtos e variações são encontrados ou cadastrados automaticamente pelos SKUs (produto pelo `productSku`; variação pelo `variantSku` e pelo preço). Nomes de cadastros existentes não são atualizados. Veja as regras na página **Checkout**. Para dar desconto, informe em `checkoutPriceInCents` um valor menor que a soma de `variantPriceInCents` dos produtos.