đź’»
Payouts Integration
  • Introduction
  • Functional overview
  • Onboarding
  • Postman Collection
  • Authentication
  • Authentication Token
    • API to Generate Token using username/password
    • API to Generate Token using private client id
  • Refresh Tokens
    • Refresh Token API
  • IP Check
  • API Integration
  • Testing Credentials
  • API Flow Diagram
  • Beneficiary Management
    • View Beneficiary Detail
    • Beneficiary Creation / Registration
  • Core Payouts API
    • Get Account Details API
    • Cancel Transfer API
    • Check Transfer Status API
    • Initiate/Schedule Transfer API
  • Verification
    • Verify Account / Penny Test
    • Validate Vpa
    • IFSC Details
  • smart send
    • Feature
    • Smart Send API
      • Cancel Smart Send
      • Smart Send Status
    • Smart Send V2 API
      • Create Smart Send Link
      • Smart Send Status
      • Cancel Smart Send
      • Extend Expiry Date
    • Bulk Smart Send
      • Bulk File Upload
      • Bulk Process File
    • Smart Send Error Codes
    • Fetch masked Vpas
  • Webhooks
    • What are Webhooks?
    • Default Webhooks
    • Creating Webhooks
    • Set Webhook API
    • Types of webhooks
  • Settings
    • Disable queued Payout
  • FAQ
Powered by GitBook
On this page
  • Low Balance webhook
  • Example
  • Deposit webhook
  • Example
  • Request processing failed
  • Example
  • Transfer success webhook
  • Example
  • Transfer failed webhook
  • Example
  • Transfer Reversed webhook
  • Example
  • Smart Send Detail Submitted
  • Example

Was this helpful?

  1. Webhooks

Types of webhooks

We notify transaction status through webhooks.

Method : Post

Headers Content-Type - application/json Request Body: Body for different webhook types is mentioned below along with description.

Low Balance webhook

The webhook event is generated when the merchant account has a low balance. The event signals to deposit money in the merchant virtual account so that upcoming transfer requests can be quickly processed.

Example

{
"event" : "LOW_BALANCE_ALERT",
"msg" : "Low Balance",
"currentBalance" : "123.2",
"alertTime" : "05 March 2019 06:13 PM"
}

Deposit webhook

Webhook event generated to signal that a deposit has been successfully processed in the merchant virtual account. The money in the account can be used to do payouts to various beneficiary accounts.

Example

{
"event" : "DEPOSIT_SUCCESS",
"msg" : "",
"transferId" : "3212312ds",
"referenceId" : "fdsfe",
"payoutMerchantId" : "1111111",
“amount” : 123;
}

Request processing failed

Webhook event generated to signal that a transfer request has failed processing.

Example

{
"event" : "REQUEST_PROCESSING_FAILED",
"msg" : "",
"payuRefId" : "3212312ds",
"merchantReferenceId" : "3212312ds"
}

Transfer success webhook

Webhook event generated to signal that a transfer has been successful.

Example

{
"event" : "TRANSFER_SUCCESS",
"msg" : "",
"payuRefId" : "3212312ds",
"merchantReferenceId" : "3212312ds",
"bankReferenceId" : "3212312ds"
}

Transfer failed webhook

Webhook event generated to signal that a transfer has failed.

Example

{
"event" : "TRANSFER_FAILED",
"msg" : "",
"payuRefId" : "3212312ds",
"merchantReferenceId" : "3212312ds",
"bankReferenceId" : "3212312ds",
"errorCode" : "23123"
}

Transfer Reversed webhook

Webhook event generated to signal that a transfer was successful but reversed after few days due to different reasons.

Example

{
"event" : "TRANSFER_REVERSED",
"msg" : "Transfer Reversed",
"payuRefId" : "3212312ds",
"merchantReferenceId" : "3212312ds",
"bankReferenceId" : "3212312ds",
}

Smart Send Detail Submitted

Webhook event generated to signal that a beneficiary has added their account details on the smart send link.

Example


{
"event" : " SMART_SEND_DETAIL_SUBMITTED",
"msg" : "Detail filled",
"linkId" : "3212312ds",
"merchantReferenceId" : "3212312ds",
"merchantMiscId" : "3212312ds"
}

PreviousSet Webhook APINextDisable queued Payout

Last updated 4 years ago

Was this helpful?