CoDi Push Notification Payment Received

This webhook is triggered when a CoDi push notification payment is completed.

Payload

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

Fields

Field	Type	Description
amount	number	The payment amount in MXN (Mexican Peso)
apiKeyId	string	The API key ID associated with this webhook
bankAccountId	string	Pey identifier (ULID) of the bank account that received the payment. Only present when bankAccountId was sent when creating the push notification. See Get Bank Account
concept	string	The concept shown to the payer
datePaid	number	Unix timestamp in seconds of when the payment was completed
metadata	object	Additional information about the transaction. See Metadata Response
numRef	string	The reference number assigned to Banxico
transactionId	string	The unique identifier (ULID) of the transaction
type	string	The event type (codi.pn.payment_received)

Example

{
  "amount": 100,
  "apiKeyId": "01M3QMMR6X9CBVDY1SF3G8QWNW",
  "bankAccountId": "01JBAVWE4NS5TGXHWGMX3KH23Q",
  "concept": "(dev) Order 45",
  "datePaid": 1790724758,
  "metadata": {
    "clabe": "000000000000000000",
    "bankCode": 40012,
    "accountType": 40,
    "description": "(dev) Order 45",
    "trackingKey": "0192191042",
    "externalMetadata": {
      "orderId": "12345",
      "customerEmail": "customer@example.com"
    }
  },
  "numRef": "4567",
  "transactionId": "01M3QR5E7XHXMNZDEPFH3JAWS0",
  "type": "codi.pn.payment_received"
}