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 to your Dashboard

  2. Navigate to Settings > Choose Developer Settings

  3. Go to 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

Last updated