Skip to content

PIX Cash In -- Generar Codigo QR

Genera un cobro PIX con codigo QR para recepcion de valores en la cuenta asociada a su API Key.

Endpoint

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

Encabezados

EncabezadoTipoObligatorioDescripcion
AuthorizationStringSiBearer {access_token}
Content-TypeStringSiapplication/json
hmacStringSiFirma HMAC-SHA512 del body (mas informacion)

Request Body

CampoTipoObligatorioDescripcionEjemplo
amountIntegerSiValor en centavos10000 (R$ 100,00)
descriptionStringNoDescripcion del cobro (max 140 caracteres)"Pedido #1234"

Valores en centavos

Todos los valores monetarios son enteros en centavos. R$ 100,00 = 10000. Divida entre 100 para obtener el valor en reales.

Ejemplo

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"

Respuesta Exitosa (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"
}
CampoTipoDescripcion
workedBooleantrue indica exito en la operacion
transaction_idStringIdentificador unico de la transaccion
end_to_end_idStringID punto a punto del BACEN (E2E)
qr_codeStringCodigo EMV copiar y pegar para pago
qr_code_imageStringImagen del codigo QR codificada en base64 (PNG)
amountIntegerValor del cobro en centavos
statusStringEstado inicial: pending (esperando pago)

Respuesta de Error (400)

json
{
  "worked": false,
  "detail": "El campo amount es obligatorio"
}

Respuesta de Error (401)

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

Respuesta de Error (422)

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

Flujo Recomendado

  1. Genere el cobro con este endpoint
  2. Muestre el codigo QR (qr_code_image) o el codigo copiar y pegar (qr_code) al pagador
  3. Reciba la confirmacion via Webhook cuando el pago sea efectuado
  4. O consulte el estado: por ID, por E2E, por Tag

Validez del Codigo QR

El codigo QR generado tiene una validez de 24 horas. Despues de este periodo, el cobro expira automaticamente y el estado cambia a cancelled.

Owem Pay Instituição de Pagamento — ISPB 37839059