Webhooks
Local Payment Methods
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
WebhookNotification.Kind.LOCAL_PAYMENT_REVERSED
WebhookNotification.Kind.LOCAL_PAYMENT_FUNDED
WebhookNotification.Kind.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
getKind()
enumThe kind of webhook notification.
getPaymentId()
stringThe payment_id of the instant or non-instant local payment. Can be used to correlate this webhook to an open order in your system.
getPaymentContextId()
stringThe id of the payment context.
getPaymentMethodNonce()
stringThe payment_method_nonce can be used to complete the instant transaction by calling Transaction: Sale. Only present for local_payment_completed webhooks.
getTransaction()
objectThe 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.
getId()
stringThe id of the transaction.
getAmount()
decimalThe amount of the transaction.
getCurrencyIsoCode()
stringCurrency code of a supported currency. See the ISO 4217 codes
getCreatedAt()
timeThe date/time the object was created. Returned in UTC.
getOrderId()
stringThe order ID of the transaction. For PayPal transactions, this field maps to the unique PayPal invoice number in your PayPal business account.
getStatus()
stringPossible values:
- Authorized
- Settled