Webhooks are call-backs to deliver data via APIs. It allows Payors to be notified when a status change occurs to their payments (i.e. payment was sent, confirmed, returned, etc.). Only Payor Master Admins users and Velo’s back office team are able to configure, remove, and reconfigure these endpoints.
Each notification will contain a sequence number starting at 1, increasing in increments of 1. This allows Payors to easily reference webhook notifications and keep track of their last received notifications should an error occur. Velo will store events for 30 days regardless of whether or not it was successfully delivered. For unsuccessful deliveries, Velo will retry sending events for up to 30 days or until successful delivery – whichever comes first.
To set up a webhook, log in to the Payor Portal and follow the steps below.
- Click Settings from the side navigation
- Toggle to enable the feature
- Enter the following:
- Webhook URL
- Authorization Header
- Click Save
The following is an example of a webhook call-back.
