Settlements Webhooks

This page provides general information about the settlement.created webhook and the data that come with it.

Property	Type	Description
id	String (UUID)	A unique identifier for the settlement report.
gross.amount	String	The total amount withdrawn from the merchant balance.
gross.currency	String	The currency of the gross amount.
fee.amount	String	The fee amount for the settlement.
fee.currency	String	The currency of the fee amount.
net.amount	String	The net amount of the settlement which is gross minus fee.
net.currency	String	The currency of the net amount.
payout.amount	String	The amount expected to be received from the merchant.
payout.currency	String	The currency of the payout amount.
account.label	String	The label of the account to which the settlement was paid out.
createTime	String (DateTime)	The UTC date and time at which the settlement report was created.

Please find the available Withdrawal webhook events and their payload examples in continuation:

settlement.created

Event name: settlement.created

This event is sent once the requested settlement has been created.

settlement.created

{
  "id": "1a0cf5d2-8f5d-4608-a7d5-f55d5a13fc24",
  "gross": {
    "amount": "999.99",
    "currency": "EUR"
  },
  "fee": {
    "amount": "16.05",
    "currency": "EUR"
  },
  "net": {
    "amount": "983.94",
    "currency": "EUR"
  },
  "payout": {
    "amount": "7342.81",
    "currency": "DKK"
  },
  "account": {
    "label": "International test"
  },
  "createTime": "2023-09-20T13:23:53.052Z"
}