Skip to content

PIX Cash In -- Gerar QR Code

Gera uma cobranca PIX com QR Code para recebimento de valores na conta associada a sua API Key.

Endpoint

POST /api/v2/external/pix/cash-in

Headers

HeaderTipoObrigatorioDescricao
AuthorizationStringSimBearer {access_token}
Content-TypeStringSimapplication/json
hmacStringSimAssinatura HMAC-SHA512 do body (saiba mais)

Request Body

CampoTipoObrigatorioDescricaoExemplo
amountIntegerSimValor em centavos10000 (R$ 100,00)
descriptionStringNaoDescricao da cobranca (max 140 caracteres)"Pedido #1234"

Valores em centavos

Todos os valores monetarios sao inteiros em centavos. R$ 100,00 = 10000. Divida por 100 para obter o valor em reais.

Exemplo

bash
BODY='{"amount":10000,"description":"Pedido #1234"}'
HMAC=$(echo -n "$BODY" | openssl dgst -sha512 -hmac "$CLIENT_SECRET" | awk '{print $2}')

curl -X POST https://api.owem.com.br/api/v2/external/pix/cash-in \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d "$BODY"

Resposta de Sucesso (200)

json
{
  "worked": true,
  "transaction_id": "PIXIN20260307a1b2c3d4e5f6",
  "end_to_end_id": "E37839059202603071530000001",
  "qr_code": "00020126580014br.gov.bcb.pix...",
  "qr_code_image": "data:image/png;base64,iVBORw0KGgo...",
  "amount": 10000,
  "status": "pending"
}
CampoTipoDescricao
workedBooleantrue indica sucesso na operacao
transaction_idStringIdentificador unico da transacao
end_to_end_idStringID ponta-a-ponta do BACEN (E2E)
qr_codeStringCodigo EMV copia-e-cola para pagamento
qr_code_imageStringImagem do QR Code codificada em base64 (PNG)
amountIntegerValor da cobranca em centavos
statusStringStatus inicial: pending (aguardando pagamento)

Resposta de Erro (400)

json
{
  "worked": false,
  "detail": "O campo amount e obrigatorio"
}

Resposta de Erro (401)

json
{
  "worked": false,
  "detail": "Token invalido ou expirado"
}

Resposta de Erro (422)

json
{
  "worked": false,
  "detail": "HMAC invalido"
}

Fluxo Recomendado

  1. Gere a cobranca com este endpoint
  2. Exiba o QR Code (qr_code_image) ou o codigo copia-e-cola (qr_code) ao pagador
  3. Receba a confirmacao via Webhook quando o pagamento for efetuado
  4. Ou consulte o status: por ID, por E2E, por Tag

Validade do QR Code

O QR Code gerado tem validade de 24 horas. Apos esse periodo, a cobranca expira automaticamente e o status muda para cancelled.

Owem Pay Instituição de Pagamento — ISPB 37839059