- REST APIs
- Welcome
- Card Payments
- 3D Secure 2
- Vault
- Getting Started
- Using the API
- Typical API Calls
- Verify That the Service Is Accessible
- Create a Profile for a Customer
- Add an Address to a Profile
- Add a Card to a Profile
- Add a Bank Account to a Profile
- Create an Apple Pay Single-Use Token
- Create a Google Pay Single-Use Token
- Create a Mobile Single-Use Token
- Create a Direct Debit Single-Use Token
- Process a Transaction Using a Payment Token
- API Reference
- Test and Go Live
- Direct Debit
- Apple Pay
- Google Pay
- Business Portal
- Partner Portal
- Alternate Payments
- Reports API
- ISV Reports
- Platforms
- Overview
- Accounts API V1
- Getting Started
- Using the API
- Typical API Calls
- Verify That the Service Is Accessible
- Create a New Merchant
- Create a New Merchant Account
- Create a New User
- Add an Address
- Create a Business Owner
- Add a Business Owner Address
- Add a Business Owner Identity Document
- Add a Merchant Bank Account
- Accept Our Terms and Conditions
- Activate the New Merchant Account
- Validate the Bank Account
- Enable Webhooks to Receive Application Statuses
- Test and Go Live
- Subaccounts
- Applications API
- Split Payouts
- Balance Transfers
- Paysafe Payments API
- Paysafe Checkout
- Paysafe JS
- Payments API
- Bad Bin API
- Reference Information
- SDKs
- Mobile SDKs
- Additional Documentation
- Resources and Support
- Shopping Carts
- Classic APIs
- Glossary
Webhooks
A webhook is a real-time push notification sent to the backend system as a JSON payload through HTTP requests. Paysafe uses webhooks to notify the system when the event happens an asynchronous notification of events such as chargebacks, returns, payments cleared, and payments completed.
Benefits
- Webhooks are more efficient than data polling.
- Webhook Notification (including data points) will be delivered only when the event happen so the backend system will always be up to date.
- Partners subscribe to Webhooks events once and notifications are delivered as soon as the event occurs.
Webhooks do not replace reporting. Webhooks provides real-time information that allows Partners and Merchants to be updated with the transactions. Paysafe recommends that Webhooks are complemented with reports to gain access to the entire set of data and metadata.
Steps to receive Webhooks
- Login into Netbanx Portal.
- Go to Settings > Notifications > Direct Debit.
- Select the events you want to monitor.
- Provide your webhook endpoint (HTTP URL) of your local server.
- Test that your webhooks endpoint is working by hitting button Test connectivity.
- Secure your Webhooks; use HMAC Secret key to verify the webhook signature generated by Paysafe.
- Save the configuration
Webhook Signature
The webhook notification contains a signature header calculated using the following algorithm:
digest = HMAC_SHA256 (hmacKey, UTF 8 string containing the JSON webhook request body)
signature = base 64 (digest)
The code that received the webhook repeats this algorithm and compare the value generated with the value received in the header.
Example Header:
Signature: UMaQ4h635wUc4hp60Z5ASBC/5UtqKybAldOkLv6ngc0=
Webhook Payload
A Webhook payload contains information about the event that occurred. It is linked to the corresponding resource that triggered the event. The payload also includes attributes such as timestamp, events topic, and the id of the resources.