Y Yuupe Pay API v1Painel
Pagamentos

Pix

Um POST cria a cobrança e devolve o QR Code na hora; o webhook avisa quando o comprador paga.

Fluxo do Pix

  1. O seu servidor chama POST /pedidos com metodo: "pix".
  2. A resposta vem com status: "aguardando_pagamento" e o bloco pix.
  3. O checkout mostra o QR Code e o copia e cola.
  4. O comprador paga no app do banco. Em segundos, o seu webhook recebe pedido.aprovado.
  5. Sem pagamento no prazo, chega pedido.expirado.

Criar o pedido

POST/pedidos
CampoDescrição
numero_pedidoobrigatório
string
O número do pedido no seu site. Único por ambiente: repetir devolve o mesmo pedido, sem novo Pix.
metodoobrigatório
"pix"
Forma de pagamento.
comprador.nomeobrigatório
string
Nome completo.
comprador.emailobrigatório
string
E-mail do comprador.
comprador.documentoobrigatório no Pix
string
CPF ou CNPJ, com ou sem pontuação. A operadora rejeita o Pix sem ele.
comprador.enderecoobrigatório no Pix
Endereco
logradouro, numero, bairro, cidade, uf, cep (complemento opcional). Dica: preencha pelo CEP (ViaCEP) e peça só o número.
itens[]obrigatório
lista de Item
descricao, quantidade, valor_unitario_centavos (sku opcional). O total do pedido é a soma.
idioma
pt-BR | pt-PT | en | es
Idioma de motivo.mensagem_comprador se algo der errado. Padrão: pt-BR.
metadados
objeto
Até 20 pares chave/valor, devolvidos no pedido e no webhook.
POST /pedidos
curl -X POST https://yuupe.me/api/v1/pay/pedidos \
  -H "Authorization: Bearer yp_test_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "numero_pedido": "NIC-2026-000123",
    "metodo": "pix",
    "idioma": "pt-BR",
    "comprador": {
      "nome": "Maria Souza",
      "email": "maria@exemplo.com",
      "documento": "529.982.247-25",
      "telefone": "+5561999990000",
      "endereco": {
        "logradouro": "Rua das Flores", "numero": "123", "bairro": "Asa Sul",
        "cidade": "Brasília", "uf": "DF", "cep": "70000-000"
      }
    },
    "itens": [
      { "descricao": "Passaporte Infantil", "quantidade": 2, "valor_unitario_centavos": 7990 }
    ]
  }'
Resposta 201
{
  "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "numero_pedido": "NIC-2026-000123",
  "ambiente": "sandbox",
  "status": "aguardando_pagamento",
  "metodo": "pix",
  "valor_centavos": 15980,
  "pix": {
    "qr_code": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v2/...",
    "qr_code_imagem": "https://.../qrcode.png",
    "expira_em": "2026-10-17T13:33:00-03:00"
  },
  "motivo": null,
  "criado_em": "2026-10-16T13:33:02-03:00",
  "pago_em": null
}

Mostrar o QR Code

Recebedor no app do banco

No app do banco, o Pix aparece para VINDI PAGAMENTOS ONLINE, a processadora da Yuupe Pay. O valor é repassado à loja pelo split. Para o comprador não estranhar, coloque perto do QR:

“No app do seu banco, o pagamento aparece para VINDI PAGAMENTOS ONLINE, a empresa que processa os pagamentos da loja.”

Validade e expiração

A validade vem em pix.expira_em. Pix não pago no prazo vira expirado e o webhook pedido.expirado é enviado. Para tentar de novo, crie outro pedido, com outro numero_pedido (por exemplo, com um sufixo -2).

Recusas no Pix
Dados incompletos ou recusados pela operadora voltam com motivo, por exemplo dados_comprador_invalidos. Mostre motivo.mensagem_comprador. Veja Erros e mensagens.