Webhooks
Local Payment Methods
Notification kinds
The notification kind, returned by calling Kind on the notification object, reveals what triggered the webhook. The WebhookNotification.Kind for Local Payment Method webhooks will be one of the following:
WebhookKind.LOCAL_PAYMENT_COMPLETEDWebhookKind.LOCAL_PAYMENT_REVERSEDWebhookKind.LOCAL_PAYMENT_FUNDEDWebhookKind.LOCAL_PAYMENT_EXPIRED
The following table describes the conditions that trigger each kind of webhook.
| Notification Type | Description |
|---|---|
| local_payment_completed | The customer has approved the instant local payment and the purchase amount has been withdrawn from their account. A transaction can now be created by calling Transaction: Sale with the payment_method_nonce. |
| local_payment_reversed | The instant local payment has been reversed and the purchased amount has been refunded to the customer's account. |
| local_payment_funded | The non-instant local payment has been completed by the buyer. |
| local_payment_expired | The non-instant local payment has expired. |
Attributes
BicstringBank Identification Code. Only present for local_payment_completed webhooks.
IbanLastCharsstringLast 4 characters of IBAN. Only present for local_payment_completed webhooks.
KindenumThe kind of webhook notification.
PaymentIdstringThe payment_id of the instant or non-instant local payment. Can be used to correlate this webhook to an open order in your system.
PaymentContextIdstringPaymentMethodNoncestringThe payment_method_nonce can be used to complete the instant transaction by calling Transaction: Sale. Only present for local_payment_completed webhooks.
PayerNamestringFirst name and last name of the payer. Only present for local_payment_completed webhooks.
BlikAliasesstringA Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given merchant. Used only in conjunction with a Consumer Reference. Only present for local_payment_completed webhooks. Only present for Blik transactions.
TransactionobjectThe transaction associated with the non-instant local payment. Can be used to query the status of the transaction. Only present for local_payment_funded webhooks.
IdstringThe id of the transaction.
AmountdecimalThe amount of the transaction.
CurrencyIsoCodestringCreatedAttimeThe date/time the object was created. Returned in UTC.
OrderIdstringThe order ID of the transaction. For PayPal transactions, this field maps to the unique PayPal invoice number in your PayPal business account.
Statusstring
Possible values:
- Authorized
- Settled