Payment Instrument Webhooks

Astra sends webhooks whenever a Payment Instrument receives an inbound payment.

Inbound Payment Received

Fired when the Payment Instrument receives an inbound payment.

Parameter	Data Type	Description
webhook_type	`string`	`inbound_payment_received`
webhook_id	`string`	The unique ID of the webhook event
user_id	`string`	The unique ID of the User (null for Payment Instrument Webhooks)
resource_id	`string`	The unique ID of the Resource (Payment Instrument ID)
metadata	`object`	The metadata object contains details on the inbound payment
metadata.amount	`float`	The amount in dollars
metadata.type	`string`	The inbound payment type (`Ach` or `Wires`)
metadata.received_timestamp	`string`	The timestamp of when the inbound payment was received in ISO 8601 format
metadata.description	`string`	A freeform text description of the transaction, populated by the Astra banking partner who maintains the payment instrument. If the banking partner does not provide a description, Astra will set this field to null

Example:

{
  "webhook_type": "inbound_payment_received",
  "webhook_id": "364f57aa-47dd-461b-8df4-d6388fb2d05e",
  "user_id": null,
  "resource_id": "1010cf30-e150-448e-8a08-bd8537eeaa50",
  "metadata": {
      "amount": 1234.56,
      "type": "Ach",
      "received_timestamp": "2025-03-17T04:00:58.137169+00:00",
      "description": "ACME PAYROLL 0421"
  }
}