Cobrança PIX

Gera um QR Code para pagamento. O PIX não passa por pré-captura e captura: a confirmação chega quando o pagador paga, e a cobrança não paga expira automaticamente.

1. Criar — você cria a cobrança e recebe o QR Code e o copia-e-cola.
2. Pagar — o pagador paga pelo app do banco.
3. Confirmar — a YumePay recebe a confirmação e envia o webhook (Webhook de venda PIX).
4. Expirar — se ninguém pagar, a cobrança expira automaticamente.

POST/api/v1/online/sales/pre-capture/

{
  "payment_type": "PIX",
  "value": 500,
  "card_holder": "JOAO DA SILVA",
  "document": "52998224725",
  "email": "[email protected]",
  "mobile": "11999999999",
  "callbackUrl": "https://meu-sistema.com/webhook/pix"
}

Campo	Tipo	Obrigatório	Descrição
payment_type	string	Sim	"PIX"
value	integer	Sim	Valor em centavos, inteiro de 1 a 2147483647 — mesma regra da seção Pré-captura com cartão de crédito
card_holder	string	Sim	Nome do pagador. O campo mantém o nome do fluxo de cartão
document	string	Não	CPF ou CNPJ
email	string	Não	E-mail do pagador
mobile	string	Não	Telefone do pagador
callbackUrl	string	Não	URL do webhook da seção Webhook de venda PIX. Precisa ser HTTPS público (veja as regras do endpoint). Também aceito como webhookUrl, webhook_url ou callback_url

aviso

URL fora da regra (http://, localhost, endereço interno, host que não resolve) devolve 400 Webhook URL must be a safe public HTTPS URL e a cobrança não é criada.

Resposta 200

{
  "status": "success",
  "data": {
    "online_sale_id": 46,
    "sale_status": "PRE_CAPTURED",
    "approved": true,
    "pix_payload": "00020101021226840014BR.GOV.BCB.PIX...",
    "pix_qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAAFAAQMAAAD3XjfpAAAABlBMVEX..."
  }
}

Campo	Descrição
pix_payload	String copia-e-cola do PIX, no formato EMV
pix_qr_code	Imagem do QR Code, PNG 320×320 em data URI. Use direto em <img src="...">
approved	No PIX, true significa cobrança emitida — não que foi paga

O sale_status nasce PRE_CAPTURED também no PIX, significando "cobrança emitida, aguardando pagamento". A confirmação chega pelo webhook (Webhook de venda PIX) ou pela consulta da seção Consultar status da venda.