> 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 ## 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)
3. Go to [Callbacks](https://dashboard.pivot-payment.com/setting/developer-setting/callbacks), then register your Payout Webhook URLs
4. Return only HTTP Response 200 for registering the Callback URLs
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 |

Check payoutResults summary:

\[SUCCESS]

  1. If the results are SUCCESS, then update the transaction status to SUCCESS on your end

\[FAILED]

  1. If the results are FAILED, then update the transaction status to FAILED on your end
  2. Retrieve Payout to check detailed reason of your transaction

\[PENDING]

  1. Retrieve Payout periodically to get the Final Status
| | PAYOUT.PENDING | The Payout request hasn’t been processed to the Bank Partner due to Insufficient Payout Balance |

Option 1:

  1. Re Top-up your Payout Balance
  2. Retry the transactions in Dashboard > Domestic Payout > Approval


Option 2:

  1. Set the transaction to FAILED on your end
  2. Re Top-up your Payout Balance
  3. Create new transactions with different Reference ID
| --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://pivot-payment.gitbook.io/pivot-docs/payouts/after-the-payout/domestic-payout/payout-wehook.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.