Receiving Notifications

As the payment lifecycle is an asynchronous process that executes over an extended period of time, it can be useful to receive notifications about status changes to the payments via a push delivery, rather than implementing a polling process to perform a recurring check on payments that were created.

To facilitate this push delivery of payment status changes, the Finexio API supports webhook subscriptions, which configures one or more remote endpoints to receive real-time notifications when a payment status is changed or updated.

Use the Webhooks API to subscribe your endpoints that will receive the payment status notifications. The Finexio platform will contact these endpoints and send a short message indicating a specific payment has been updated. Upon receipt of this notification, a request can be initiated to the Payments API to retrieve the latest details of the payment.

A sample webhook request that is sent to a subscribed endpoint will look like this:

{
    "object_type": "payment",
    "object_id": "pmt_mnXYAtWkNQEGbOGoDaOFJDREAekAlZh",
    "event": "payment.changed"
}