Cobranças (cash in)

Crie cobranças por PIX, cartão de crédito ou boleto e acompanhe a confirmação do pagamento.

Criar uma cobrança

POST/api/v1/direct-paymentsChave de API · permissão sales

Cria uma cobrança avulsa, sem produto cadastrado. O valor vai em centavos e o resultado do pagamento chega depois, por webhook.

Campo	Tipo	Obrigatório	Descrição
amount	number	Sim	Valor em centavos (mínimo 1). R$ 99,90 = 9990
description	string	Sim	De 3 a 255 caracteres. Alguns provedores mostram este texto ao pagador
paymentMethod	string	Sim	"pix", "credit_card" ou "bank_slip"
customer.name	string	Sim	Nome completo do comprador (3 a 128 caracteres)
customer.email	string	Sim	E-mail do comprador
customer.document	string	Sim	CPF (11) ou CNPJ (14), somente dígitos
customer.phone	string	Não	Formato E.164: +5511999999999
customer.address	object	Não	zipCode, street, number, district, city, state, complement
cardData	array	Condicional	Obrigatório quando paymentMethod = credit_card
useTwoCards	boolean	Não	Divide o pagamento em dois cartões

PIX

curl -X POST "https://api.apix.tec.br/api/v1/direct-payments" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: pk_live_a1b2c3d4..." \
  -d '{
    "amount": 9990,
    "description": "Pedido #123",
    "paymentMethod": "pix",
    "customer": {
      "name": "João da Silva",
      "email": "joao@email.com",
      "document": "12345678901",
      "phone": "+5511999999999"
    }
  }'

Resposta 201

{
  "hasError": false,
  "data": {
    "transaction_id": "A1B2C3D4E5F6",
    "total_value": 99.90,
    "status": "PENDING",
    "email": "joao@email.com",
    "payment_method": "pix",
    "payment_data": {
      "payment_id": "id-da-cobranca-no-provedor",
      "pix_key": "00020101021226790014br.gov.bcb.pix...",
      "expiration_date": "2026-09-16T18:00:00.000Z",
      "status": "PENDING"
    }
  }
}

payment_data.pix_key é o PIX copia e cola: mostre como texto copiável e como QR Code. O status nasce PENDING — o pagamento ainda não aconteceu.

Cartão de crédito

Envie cardData com um item (ou dois, com useTwoCards). A soma dos valores precisa fechar com amount.

Campo	Tipo	Descrição
cardNumber	string	Número do cartão, somente dígitos
cardHolderName	string	Nome impresso no cartão
cardExpirationDate	string	MM/AA ou MM/AAAA
cardCvv	string	Código de segurança
parcels	number	Número de parcelas
value	number	Valor cobrado neste cartão, em centavos

Dados de cartão só podem trafegar do seu servidor para a APIX. Nunca envie do navegador do comprador.

Consultar o status

GET/api/v1/payments/{transaction_id}/statusPública

Use como plano B do webhook, com intervalo de 5 segundos ou mais. O transaction_id é o da resposta da criação.

Consulta

curl "https://api.apix.tec.br/api/v1/payments/A1B2C3D4E5F6/status"

A lista completa de status está em Status e erros.

Checkout de produto

GET/api/v1/products/{shortId}/checkoutPública

POST/api/v1/paymentsPública

Se você vende um produto cadastrado na APIX, monte a página de checkout com os dados do produto e crie o pagamento por essas rotas, sem chave de API. O corpo é parecido com o do pagamento direto, trocando o valor livre por productLink (o short ID) e paymentValue.

Repetição e conciliação

Cuidado	Recomendação
Timeout na criação	Não repita às cegas: consulte o status do pedido antes de criar outra cobrança
Conciliação	Guarde transaction_id junto do seu pedido; ele identifica a venda em webhooks e consultas
Valores	Confira o valor recebido no webhook antes de liberar o pedido