Additional webhooks
The following are additional webhooks that will provide notifications around authorizations,
authorization/update webhook
On every new Authorization or Authorization status change, you will receive a webhook notification to your server.
The body will include the AuthorizationResult object:
Parameter | Always Available | Type | Description |
|---|---|---|---|
| Yes | String | Unique ID of the Object |
| Yes | Enum | The status of the Authorization. See below detailed information |
| Yes | String | The Currency of the payment |
| Yes | Number | The Amount of the payment |
| Yes | String | Unique ID from the merchant system |
| Yes | Object | The items of the order per item per vendor |
| Yes | String | The transaction ID of the specific payment operation |
| Yes | String | The method of the payment (creditCard, bankTransfer, directDebit, e.t.c) |
| Yes | String | Unique ID of the checkout that has been paid |
| Yes | String | Current status of the Checkout |
| Yes | String | Unique ID of the vendor |
| Yes | Object | Payment Option object that could represent card payment:\ or bank transfer payment:\ |
| No | String | Unique ID of the recurring payment plan |
| No | String | Unique ID of the recurring subscription |
| No | String | The reason why payment has been declined |
| No | String | Description of payment |
| No | Object | The custom data that was used during checkout creation (this field can be used to pass some internal data through payment process) |
| No | String | The email of buyer that made a payment |
| No | String | Unique ID of the buyer |
| Yes | String | Unique ID from the merchant system |
payout/update webhook
Payout notifications notify you of every newly created payout and any change in the status of a payout. The webhook notification gets sent to your server.
The body will include the PayoutResult object:
| Parameter | Always Available | Type | Description |
|---|---|---|---|
payoutId | yes | string | |
status | yes | Enum | |
amount | yes | number | |
currency | yes | string | |
createdDate | yes | date | |
updatedDate | yes | date | |
targetReferenceId | no | string | |
| reconciled | yes | string |
ewallet/create webhook
Account notifications are created to notify you when your vendor receives money for the first time - creating an automatic account in the accepted currency. Each time an account balance is created or disabled, you'll get a webhook notification to your server, indicating its current status.
The body will include the following object:
Parameter | Always Available | Type | Description |
|---|---|---|---|
| yes | string | Account unique identifier |
| no | string | The unique ID of the vendor's Account. |
| yes | string | Unique ID of the platform |
| yes | enum | USD, GBP, EUR |
| yes | string | Ewallet Status ("created") |
Updated 10 days ago
