Notification kinds

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The webhookNotification.getKind() for local payment method webhooks will be one of the following:

  • WebhookNotification.Kind.LOCAL_PAYMENT_COMPLETED

The following table describes the conditions that trigger each kind of webhook.

Notification Type Description
local_payment_completed

Customer has approved the local payment method and the purchase amount has been withdrawn from their account. The transaction can now be executed by calling Transaction.sale() with the payment_method_nonce.

Attributes

getKind() enum

The kind of webhook notification.

getPaymentId() string

The payment_id of the local payment method. Can be used to correlate this webhook to an open order in your system.

getPayerId() string

The payer_id of the local payment method.

getPaymentMethodNonce() string

The payment_method_nonce to be used to complete the transaction by calling Transaction.sale().

getTransaction() string

The local payment transaction. Can be used to query the status of the transaction.