> For the complete documentation index, see [llms.txt](https://pivot-payment.gitbook.io/pivot-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pivot-payment.gitbook.io/pivot-docs/payouts/after-the-payout/domestic-payout/payout-wehook.md).

# Payout Wehook

Receive real-time updates on your payout status directly to your configured endpoint. Ideal for automating reconciliation, notifying users, or triggering follow-up actions

## Create a Webhook endpoint

Before handling payout events, make sure to register your webhook endpoint in the Dashboard. This allows us to notify your server when events occur, so your handler can process them accordingly.

Follow these steps:

1. [Log in](https://dashboard.pivot-payment.com/login) to your Dashboard
2. Navigate to Settings > Choose [Developer Settings](https://dashboard.pivot-payment.com/setting/developer-setting/credentials)<br>

   <figure><img src="https://1065010181-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5XnFyAqUQIKsWcJrrnCz%2Fuploads%2Fg1ivZSVGhMuagRqqERsJ%2FRegister%20Callback%201.png?alt=media&amp;token=75e47e94-0e1c-47b3-97c7-21da720d6075" alt=""><figcaption></figcaption></figure>
3. Go to [Callbacks](https://dashboard.pivot-payment.com/setting/developer-setting/callbacks), then register your Payout Webhook URLs<br>

   <figure><img src="https://1065010181-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5XnFyAqUQIKsWcJrrnCz%2Fuploads%2FtI4xjpVGRczqHNXiM3iS%2FRegister%20Callback%202.png?alt=media&amp;token=081dd841-8433-4f11-ad6d-dcf291b394f8" alt=""><figcaption></figcaption></figure>
4. Return only HTTP Response 200 for registering the Callback URLs<br>

   <figure><img src="https://1065010181-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5XnFyAqUQIKsWcJrrnCz%2Fuploads%2FaUVIY6ssxfA9I6MgOMe2%2FRegister%20Callback%203.png?alt=media&amp;token=df1f14d6-c5f0-4cc2-96ae-acc84f9c0d9f" alt=""><figcaption></figcaption></figure>

Once registered, every Domestic Payout event will automatically be sent to your callback URL

## Create a Payout event handler

Set up a handler to receive and process payout webhook events, allowing your system to automatically react to payout status updates:

| Event Name     | Description                                                                                     | Action                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| -------------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| PAYOUT.DONE    | The Payout request has already been processed by Bank Partner                                   | <p>Check <code>payoutResults</code> summary:</p><p></p><p>\[SUCCESS]</p><ol><li>If the results are SUCCESS, then update the transaction status to SUCCESS on your end</li></ol><p></p><p>\[FAILED]</p><ol><li>If the results are FAILED, then update the transaction status to FAILED on your end</li><li><a href="/pivot-docs/api-references/api-lists/payout-local/retrieve-a-payout.md">Retrieve Payout</a> to check detailed reason of your transaction</li></ol><p></p><p>\[PENDING]</p><ol><li><a href="/pivot-docs/api-references/api-lists/payout-local/retrieve-a-payout.md">Retrieve Payout</a> periodically to get the Final Status</li></ol> |
| PAYOUT.PENDING | The Payout request hasn’t been processed to the Bank Partner due to Insufficient Payout Balance | <p>Option 1: </p><ol><li>Re <a href="/pivot-docs/payouts/top-up-balance.md">Top-up</a> your Payout Balance</li><li>Retry the transactions in Dashboard > Domestic Payout > <a href="https://dashboard.pivot-payment.com/disbursement/approval">Approval</a></li></ol><p><br></p><p>Option 2: </p><ol><li>Set the transaction to FAILED on your end</li><li>Re <a href="/pivot-docs/payouts/top-up-balance.md">Top-up</a> your Payout Balance</li><li>Create new transactions with different Reference ID</li></ol>                                                                                                                                       |
