You can setup webhooks to listen for events on your account so your integration can automatically trigger reactions.
OpenPayd uses webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like when an account receives a pay-in or a transaction is completed.
To use webhooks with your OpenPayd integration:
- Create a webhook endpoint on your server.
- Configure the endpoint and events with OpenPayd.
- Simulate an event to test your webhook endpoint.
- Implement validation of webhook signatures (Optional)
You can easily configure webhooks on the Webhooks page on your Dashboard.
You can receive webhooks for the following events:
- Pay In Completed
- Pay In Processing
- Pay In Failed
- Payout Completed
- Payout Failed
- Payout Cancelled
- Transfer Completed
- Transfer Failed
- Transfer Cancelled
- Exchange Completed
- Exchange Failed
- Return In Completed
- Return Out Completed
- Fee Completed
- Account Status Updated
To acknowledge receipt of an event, your endpoint must return a
2xx HTTP status code to OpenPayd. All response codes outside this range, including
3xx codes, indicate to OpenPayd that you did not receive the event.
If an event is not acknowledged by returning a
2xx HTTP status code to OpenPayd, we will retry the webhook for up to 24 hours with an exponential back off.
Updated 6 months ago