Skip to main content

Resumen

El cash-in en Brasil crea un cobro PIX en una cuenta BRL. La API devuelve QR y/o copia y cola PIX. La transacción permanece en pending hasta confirmar el pago. La cuenta debe ser BRL y país BR.

Requisitos

  • Token Bearer con acceso a la cuenta BRL
  • email del pagador (obligatorio en la API)
  • document del pagador — CPF o CNPJ (obligatorio en la API)

Flujo

  1. POST /api/v1/br/transactions/inbound — accountId, amount, email y document
  2. Mostrar qrCode o pixCopiaECola al pagador
  3. Opcional: GET /api/v1/br/transactions/{id}/status o webhookUrl — ver Recepción de webhooks

Ejemplo

La transacción inicia en pending y pasa a done al confirmarse el PIX. Cuando se confirma el pago, HG.Cash envía un webhook de movimiento de cuenta (topic TRANSACTION, eventType status_change) a la webhookUrl de la solicitud o a tu URL de webhook predeterminada. Si el movimiento guarda un identificador end-to-end de PIX, ese cuerpo incluye endToEndId. El campo se omite cuando el identificador está ausente o vacío. Ver Identificador end-to-end PIX.

Estado de la cuenta

La cuenta origen debe estar Operativa. Las solicitudes contra cuentas Bloqueada o Cerrada devuelven 403 con code: ACCOUNT_NOT_OPERATIVE.