VamPay
VamPay

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.

Todos os endpoints desta página precisam da sua API Key no header X-API-Key.

Produtos

GET/checkout/products

Lista os seus produtos.

POST/checkout/products
ParâmetroTipo
name*string
price*number
description*string
type*string
imageUrlstring
bannerUrlstring
skustring
curlbash
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": { ... } } }.

PUT/checkout/products/{id}

Atualiza os mesmos campos acima.

DELETE/checkout/products/{id}

Remove o produto.

Checkouts

GET/checkout/checkouts
POST/checkout/checkouts
ParâmetroTipo
productId*string
slugstring
activeboolean
customerFieldsobject
deliveryobject
stockobject
themestring
accentColorstring
pixelIds / tiktokPixelIds / googleAdsIdsstring[]

Responde 201 com o checkout criado em data.checkout. Os demais ajustes visuais ficam no painel.

PUT/checkout/checkouts/{id}
DELETE/checkout/checkouts/{id}

Cupons

GET/checkout/coupons
POST/checkout/coupons
ParâmetroTipo
code*string
type*string
discount*number
productIdsstring[]
expiresAtstring
PUT/checkout/coupons/{id}
DELETE/checkout/coupons/{id}

Pedidos

GET/checkout/orders
ParâmetroTipo
pagenumber
limitnumber
200 OKjson
{
  "success": true,
  "data": {
    "orders": [ { "_id": "...", "status": "PAID", "productId": { "name": "Curso de Pix", "price": 97 } } ],
    "pagination": { "total": 1, "page": 1, "limit": 20 }
  }
}
PATCH/checkout/orders/{id}/deliver

Marca 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.