Payouts webhook event names

DocsCurrentLast updated: October 6th 2021, @ 7:03:26 pm

Note: The PAYOUTSBATCH webhooks do not contain item-related information.

To get item-related information, use the HATEOAS links from the webhooks response.

EventTriggerRelated method
PAYMENT.PAYOUTSBATCH.DENIEDA batch payout payment is denied.Show payout details
PAYMENT.PAYOUTSBATCH.PROCESSINGThe state of a batch payout payment changes to processing.Show payout details
PAYMENT.PAYOUTSBATCH.SUCCESSA batch payout payment completes successfully.Show payout details
PAYMENT.PAYOUTS-ITEM.BLOCKEDA payouts item is blocked.Show payout item details
PAYMENT.PAYOUTS-ITEM.CANCELEDA payouts item is canceled.Cancel unclaimed payout item
PAYMENT.PAYOUTS-ITEM.DENIEDA payouts item is denied.Show payout item details
PAYMENT.PAYOUTS-ITEM.FAILEDA payouts item fails.Show payout item details
PAYMENT.PAYOUTS-ITEM.HELDA payouts item is held.Show payout item details
PAYMENT.PAYOUTS-ITEM.REFUNDEDA payouts item is refunded.Show payout item details
PAYMENT.PAYOUTS-ITEM.RETURNEDA payouts item is returned.Show payout item details
PAYMENT.PAYOUTS-ITEM.SUCCEEDEDA payouts item succeeds.Show payout item details
PAYMENT.PAYOUTS-ITEM.UNCLAIMEDA payouts item is unclaimed.Show payout item details