Webhooks

Local Payment Methodsanchor

Notification kindsanchor

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The webhook_notification.kind for Local Payment Method webhooks will be one of the following:

  • Braintree::WebhookNotification::Kind::LocalPaymentCompleted
  • Braintree::WebhookNotification::Kind::LocalPaymentReversed
  • Braintree::WebhookNotification::Kind::LocalPaymentFunded
  • Braintree::WebhookNotification::Kind::LocalPaymentExpired

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.

Attributesanchor

kindenum

The kind of webhook notification.

payment_idstring

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

payment_context_idstring

The id of the payment context.

payment_method_noncestring

The payment_method_nonce can be used to complete the instant transaction by calling Transaction: Sale. Only present for local_payment_completed webhooks.

transactionobject

The 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.

idstring

The id of the transaction.

amountdecimal

The amount of the transaction.

currency_iso_codestring

Currency code of a supported currency. See the ISO 4217 codes

created_attime

The date/time the object was created. Returned in UTC.

order_idstring

The 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