Skip to main content
To receive notifications about payment status changes and other events, set up webhooks.
You can use extended webhooks to receive extra metadata. For more details, see Set up extended webhooks.

Set up webhook notifications

Webhook notifications are available for three endpoints: Create a payment, Create a payout and Create a payment link. To enable webhook notifications, pass webhookUrl in the request parameters.
{
  "webhookUrl": "https://example.com/exampleURL"
}

{
 "PaymentId":"bc973098-3dfb-4700-af20-28ca4fdb583a",
 "Status":"Done",
 "Signature":"b2e286bfc7b94ab2342342341881c85b50f286b23462436432d7dfc5fcd05ca2r234r231",
 "MerchantPaymentId":"12345678-1234-1234-1234-12345678910",
 "Reference":"12345678 PAYMENT",
 "Amount":50.0,
 "Currency":"EUR",
 "CardId":null,
 "Remitter":{
    "Name":"User Testing",
    "Iban":"TT123456789HFE112345",
    "SortCode":null,
    "AccountNumber":null
 },
 "AdditionalData":null,
 "DetailedInfo":null,
 "Method":"open-banking",
 "BankId":"sparkasse_de",
 "IsSenderBank":false,
 "BankTransactionId":"BANKTRANSACTIONID",
 "Settled":"Yes",
 "SettlementDate":"2024-10-01T07:18:56.316302Z"
}

Alternative options

Apart from setting up webhook notifications, you can also receive up-to-date payment and payout data via returnUrl and status check endpoints. For more details, see Retrieve payment details and Retrieve a payout