Checkout
Venda produtos com uma página de checkout pronta: cadastre o produto, crie o checkout, ofereça cupons e entregue os pedidos pagos.
Como funciona
Você cadastra um produto, cria um checkout ligado a ele e divulga o endereço https://vampay.com.br/checkout/{slug}. Quando o cliente paga, vira um pedido e você recebe transaction.completed no webhook. A aparência avançada (template, pixels, prova social) é ajustada pelo painel.
X-API-Key.Produtos
/checkout/productsLista os seus produtos.
/checkout/products| Parâmetro | Tipo | Descrição |
|---|---|---|
name* | string | Nome do produto |
price* | number | Preço em reais. Mínimo R$ 0,01 |
description* | string | Descrição |
type* | string | DIGITAL, PHYSICAL ou SERVICE |
imageUrl | string | Imagem do produto |
bannerUrl | string | Banner do checkout |
sku | string | Código interno seu |
curl -X POST "https://api.vampay.com.br/checkout/products" \
-H "X-API-Key: vampay_sua_api_key" \
-H "Content-Type: application/json" \
-d '{ "name": "Curso de Pix", "price": 97.00, "description": "Acesso vitalício", "type": "DIGITAL" }'Responde 201 com { "success": true, "data": { "product": { ... } } }.
/checkout/products/{id}Atualiza os mesmos campos acima.
/checkout/products/{id}Remove o produto.
Checkouts
/checkout/checkouts/checkout/checkouts| Parâmetro | Tipo | Descrição |
|---|---|---|
productId* | string | ID do produto que este checkout vende (404 se não for seu) |
slug | string | Endereço do checkout. Só letras minúsculas, números e hífen. Se já existir, a VamPay acrescenta um sufixo. Sem slug, é gerado um |
active | boolean | false tira o checkout do ar |
customerFields | object | Quais dados pedir ao cliente: name, email, phone, cpf e address (true/false) |
delivery | object | Entrega: type (LINK_FIXED ou STOCK_PER_LINE) e content (o link ou os itens, um por linha) |
stock | object | Estoque: unlimited (boolean) e quantity (number) |
theme | string | DARK ou LIGHT |
accentColor | string | Cor de destaque, em hexadecimal (ex.: #b266ff) |
pixelIds / tiktokPixelIds / googleAdsIds | string[] | Pixels de rastreamento cadastrados no painel |
Responde 201 com o checkout criado em data.checkout. Os demais ajustes visuais ficam no painel.
/checkout/checkouts/{id}/checkout/checkouts/{id}Cupons
/checkout/coupons/checkout/coupons| Parâmetro | Tipo | Descrição |
|---|---|---|
code* | string | Código do cupom (fica em maiúsculas; 409 se você já tem um igual) |
type* | string | PERCENTAGE (porcentagem) ou FIXED (valor em reais) |
discount* | number | Desconto. Em PERCENTAGE vai de 1 a 100 |
productIds | string[] | Produtos em que vale. Vazio = todos |
expiresAt | string | Validade (ISO 8601) |
/checkout/coupons/{id}/checkout/coupons/{id}Pedidos
/checkout/orders| Parâmetro | Tipo | Descrição |
|---|---|---|
page | number | Página (padrão: 1) |
limit | number | Itens por página (padrão: 20) |
{
"success": true,
"data": {
"orders": [ { "_id": "...", "status": "PAID", "productId": { "name": "Curso de Pix", "price": 97 } } ],
"pagination": { "total": 1, "page": 1, "limit": 20 }
}
}/checkout/orders/{id}/deliverMarca um pedido PAID como DELIVERED. Pedido que ainda não foi pago responde 400 (“Apenas pedidos pagos podem ser entregues”). Você pode enviar { "deliveryContent": "..." } com o que foi entregue.
