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.

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.

cpf*string

CPF do aluno para quem é a venda. Não pode ser alterado no checkout.

externalSaleId?string

ID da venda no seu sistema.

Tamanholength <= 40

checkoutPriceInCents*integer

Preço total da venda no checkout, em centavos. Deve ser menor ou igual à soma dos produtos e estar dentro dos limites de valor da sua conta.

upfrontInCents?integer

Entrada, em centavos. Opcional. O mínimo é o maior entre o percentual de entrada padrão da sua conta aplicado à soma dos produtos e R$ 30,00 (3000 centavos). Precisa ser menor que a soma dos produtos. Sem este campo, vale o mínimo.

returnUrl?string

Armazenado, hoje não redireciona o comprador.

Formatouri

products*array<>

Itens1 <= items

buyer*

Dados do comprador. O objeto é obrigatório, mas os campos são opcionais: o que não for enviado é pedido no checkout.

Corpo da Resposta

`application/json`

curl -X POST "https://example.com/sales" \  -H "Content-Type: application/json" \  -d '{    "cpf": "48096807544",    "externalSaleId": "aef2828a-e9eb-4714-b0b5-aa3edf15f31d",    "checkoutPriceInCents": 100000,    "products": [      {        "productSku": "01946620-fba3-74c7-8473-38337b3f08b1",        "productName": "Light Saber 101",        "variantSku": "01946621-1706-7cc4-8e7e-67dbd3d9ab6e",        "variantName": "Light Saber 101",        "variantPriceInCents": 100000      }    ],    "buyer": {      "name": "Darth Vader",      "phone": "71999999999",      "email": "darth.vader@empire.com",      "zipCode": "04548004",      "street": "Av. Dr. Cardoso de Melo",      "number": "1340",      "district": "Vila Olimpia",      "city": "São Paulo",      "complement": "Cj 11"    }  }'

{  "checkoutUrl": "https://pay-staging.principia.net/checkout/web-development-school?classes=44099&saleId=31397dea-d328-4135-9619-a6ed4ca7713f",  "externalSaleId": "aef2828a-e9eb-4714-b0b5-aa3edf15f31d",  "saleId": 1582050}

Autorização

Corpo da Requisição

Corpo da Resposta

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`