Pago de QR CoDi recibido

Este webhook se dispara cuando se recibe un pago en un QR CoDi creado a través de la API.

Payload

{
  "amount": "number",
  "apiKeyId": "string",
  "bankAccountId": "string",
  "codiQrId": "string",
  "concept": "string",
  "datePaid": "number",
  "metadata": "object",
  "numRef": "string",
  "transactionId": "string",
  "type": "codi.qr.payment_received"
}

Campos

Campo	Tipo	Descripción
amount	number	El monto recibido en MXN (pesos mexicanos)
apiKeyId	string	El ID de la API key asociada a este webhook
bankAccountId	string	Identificador de Pey (ULID) de la cuenta bancaria que recibió el pago. Solo está presente cuando se envió bankAccountId al crear el QR. Ver Get Bank Account
codiQrId	string	El identificador del QR CoDi (IDC) asignado por Banxico
concept	string	El concepto que se muestra al pagador
datePaid	number	Marca de tiempo Unix en segundos de cuándo se completó el pago
metadata	object	Información adicional de la transacción. Ver Respuesta de metadata
numRef	string	El número de referencia asignado a Banxico
transactionId	string	Identificador único (ULID) de la transacción
type	string	El tipo de evento (codi.qr.payment_received)

Ejemplo

{
  "amount": 150,
  "apiKeyId": "01M3QMMR6X9CBVDY1SF3G8QWNW",
  "bankAccountId": "01JBAVWE4NS5TGXHWGMX3KH23Q",
  "codiQrId": "35a13c183a",
  "concept": "(dev) Order 345",
  "datePaid": 1790724818,
  "metadata": {
    "clabe": "000000000000000000",
    "bankCode": 40012,
    "accountType": 40,
    "description": "(dev) Order 345",
    "trackingKey": "0192191042",
    "externalMetadata": {
      "orderId": "12345",
      "customerEmail": "customer@example.com"
    }
  },
  "numRef": "34567",
  "transactionId": "01M3QR8H0RH0XBCKYYD242YXNV",
  "type": "codi.qr.payment_received"
}