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
`authorizationId`	Yes	String	Unique ID of the Object
`authorizationStatus`	Yes	Enum	The status of the Authorization. See below detailed information
`currency`	Yes	String	The Currency of the payment
`amount`	Yes	Number	The Amount of the payment
`orderid`	Yes	String	Unique ID from the merchant system
`items`	Yes	Object	The items of the order per item per vendor
`transactionId`	Yes	String	The transaction ID of the specific payment operation
`paymentMethod`	Yes	String	The method of the payment (creditCard, bankTransfer, directDebit, e.t.c)
`checkoutId`	Yes	String	Unique ID of the checkout that has been paid
`vendorId`	Yes	String	Unique ID of the vendor
`paymentOption`	Yes	Object	Payment Option object that could represent card payment: `{ cardAccount: { brand: "VISA" bin: "476134" last4Digits: "1390", issuerCountry: "GB" } }` or bank transfer payment: `{ bankAccount: { brand: "Mock Bank" } }`
`planId`	No	String	Unique ID of the recurring payment plan
`subscriptionId`	No	String	Unique ID of the recurring subscription
`declinedReason`	No	String	The reason why payment has been declined
`description`	No	String	Description of payment In most cases value is taken from checkout creation
`metadata`	No	Object	The custom data that was used during checkout creation (this field can be used to pass some internal data through payment process)
`consumerEmail`	No	String	The email of buyer that made a payment
`consumerId`	No	String	Unique ID of the buyer
`reference`	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
`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
`eWalletId`	yes	string	Account unique identifier
`vendorId`	no	string	The unique ID of the vendor's Account. If the Account belongs to the platform, it will return null
`platformId`	yes	string	Unique ID of the platform
`currency`	yes	enum	USD, GBP, EUR
`status`	yes	string	Ewallet Status ("created")