- 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
Webhook Samples
Testing Connectivity
When you use the Test Connectivity button, a successful test will generate a 200 message in the back office UI.
The webhook payload for a connectivity request looks like this.
{
"mode": "test",
"eventDate": "2017-09-06T19:54:05Z",
"eventType": "test",
"attemptNumber": 1
}Testing Webhooks
When you use the Send Test Webhook button, you can select the event type that you want to simulate. The following test response is for a completed payment.
Webhook Example {
"resourceId": "068c506c-82e7-4578-8ea2-3d141430b69d",
"mode": "test",
"eventDate": "2017-09-07T13:27:32Z",
"eventType": "AP_PAYMENT_COMPLETED",
"attemptNumber": 1,
"payload": {
"id": "068c506c-82e7-4578-8ea2-3d141430b69d",
"accountId": "YOUR_ACCOUNT_ID",
"merchantRefNum": "YOUR_REFERENCE_NUMBER",
"paymentType": "PAYSAFECARD",
"amount": 1000,
"currencyCode": "EUR",
"status": "COMPLETED",
"txnTime": "2017-09-07T13:27:32Z"
},
"links": [{
"rel": "payment",
"href": "http://api.test.paysafe.com/alternatepayments/v1/accounts/YOUR_ACCOUNT_ID/payments/068c506c-82e7-4578-8ea2-3d141430b69d"
}]
}The following table describes the elements in the webhook response:
| Element | Type | Constraints | Required | Description |
|---|---|---|---|---|
| id | String | Max = 36 | Yes | This is the webhook event ID. |
| resourceId | String | Max = 255 | Yes | The ID of the resource that has changed. |
| mode | String | live / test | Yes |
|
| eventDate | dateTime | UTC formatted date | Yes | This is the date and time the event occurred. |
| eventType | String | Max = 255 | Yes | This is the type of event. |
| attemptNumber | Integer | Yes | This is the number of times this event has been sent. | |
| links | Complex | Yes | This is a link to the resource. | |
| payload | Complex | No | The payload varies depending on the eventType. |