Payout Webhooks

The payload remains the same for IMPS, NEFT and RTGS modes for fund_account_type bank_account. That is, the payload is same for a payout done to a bank account, through IMPS, NEFT or RTGS.

List of Payouts Webhook Events

The table below lists the webhook events available for RazorpayX Payouts.

Handy Tips

The error object has been deprecated.

Sample Payloads

Given below are the sample payloads for Payouts webhooks.

Payout Pending

{
  "entity":"event",
  "account_id":"acc_BfVUrG6tDiL7H0",
  "event":"payout.pending",
  "contains":[
    "payout"
  ],
  "payload":{
    "payout":{
      "entity":{
        "id":"pout_1Aa00000000001",
        "entity":"payout",
        "fund_account_id":"fa_1Aa00000000001",
        "amount":100,
        "currency":"INR",
        "notes":{
          "note_key 1":"Tea. Earl Gray. Hot.",
          "note_key 2":"Tea. Earl Gray. Decaf."
        },
        "fees":0,
        "tax":0,
        "status":"pending",
        "purpose":"refund",
        "utr":null,
        "mode":"NEFT",
        "reference_id":null,
        "narration":"Test Fund Transfer",
        "debit_account_number": "null",
        "batch_id":null,
        "status_details": {
          "description": "Confirmation of the credit to the beneficiary is pending from HDFC bank. Please check the status after after 24th October 2021, 10:40 PM",
          "source": "beneficiary_bank",
          "reason": "beneficiary_bank_confirmation_pending"
        }
        "created_at":1580808301,
        "fee_type": ""
      }
    }
  },
  "created_at":1580808301
}

Know about the

Payouts Approval Payload

Payout Rejected

{
  "entity":"event",
  "account_id":"acc_BfVUrG6tDiL7H0",
  "event":"payout.rejected",
  "contains":[
    "payout"
  ],
  "payload":{
    "payout":{
      "entity":{
        "id":"pout_1Aa00000000001",
        "entity":"payout",
        "fund_account_id":"fa_1Aa00000000001",
        "amount":10000,
        "currency":"INR",
        "notes":{
          "note_key 1":"Tea. Earl Gray. Hot.",
          "note_key 2":"Tea. Earl Gray. Decaf."
        },
        "fees":0,
        "tax":0,
        "status":"rejected",
        "purpose":"refund",
        "utr":null,
        "mode":"NEFT",
        "reference_id":null,
        "narration":"Acme Fund Transfer",
        "debit_account_number": "null",
        "batch_id":null,
        "status_details": {
          "description": "Payout rejected by beneficiary bank. Please contact beneficiary bank",
          "source": "beneficiary_bank",
          "reason": "beneficiary_bank_rejected"
        }
        "created_at":1581512005,
        "fee_type": ""
      }
    }
  },
  "created_at":1581512006
}

Payout Queued

{
  "entity":"event",
  "account_id":"acc_BfVUrG6tDiL7H0",
  "event":"payout.queued",
  "contains":[
    "payout"
  ],
  "payload":{
    "payout":{
      "entity":{
        "id":"pout_1Aa00000000001",
        "entity":"payout",
        "fund_account_id":"fa_1Aa00000000001",
        "amount":286540,
        "currency":"INR",
        "notes":{
          "note_key 1":"Tea. Earl Gray. Hot.",
          "note_key 2":"Tea. Earl Gray. Decaf."
        },
        "fees":0,
        "tax":0,
        "status":"queued",
        "purpose":"payout",
        "utr":null,
        "mode":"IMPS",
        "reference_id":null,
        "narration":"Acme Fund Transfer",
        "debit_account_number": "null",
        "batch_id":null,
        "status_details": {
          "description": "Payout is queued as there is insufficient balance in your business account to process the payout",
          "source": "business",
          "reason": "low_balance"
        }
        "created_at":1580119445,
        "fee_type": ""
      }
    }
  },
  "created_at":1580119445
}

Payout Initiated

{
  "entity":"event",
  "account_id":"acc_BfVUrG6tDiL7H0",
  "event":"payout.initiated",
  "contains":[
    "payout"
  ],
  "payload":{
    "payout":{
      "entity":{
        "id":"pout_1Aa00000000001",
        "entity":"payout",
        "fund_account_id":"fa_1Aa00000000001",
        "amount":100,
        "currency":"INR",
        "notes":{
          "note_key 1":"Tea. Earl Gray. Hot.",
          "note_key 2":"Tea. Earl Gray. Decaf."
        },
        "fees":590,
        "tax":90,
        "status":"processing",
        "purpose":"refund",
        "utr":null,
        "mode":"NEFT",
        "reference_id":null,
        "narration":"Acme Fund Transfer",
        "debit_account_number": "00228130001287",
        "batch_id":null,
        "status_details": {
          "description": "Confirmation of the credit to the beneficiary is pending from HDFC bank. Please check the status after after 24th October 2021, 10:40 PM",
          "source": "beneficiary_bank",
          "reason": "beneficiary_bank_confirmation_pending"
        }
        "created_at":1579865132,
        "fee_type": "",
      }
    }
  },
  "created_at":1579865132
}

Payout Processed

{
  "entity":"event",
  "account_id":"acc_BfVUrG6tDiL7H0",
  "event":"payout.processed",
  "contains":[
    "payout"
  ],
  "payload":{
    "payout":{
      "entity":{
        "id":"pout_1Aa00000000001",
        "entity":"payout",
        "fund_account_id":"fa_1Aa00000000001",
        "amount":100,
        "currency":"INR",
        "notes":{
          "note_key 1":"Tea. Earl Gray. Hot.",
          "note_key 2":"Tea. Earl Gray. Decaf."
        },
        "fees":3,
        "tax":0,
        "status":"processed",
        "purpose":"payout",
        "utr":"qwer1yuijaaasss",
        "mode":"IMPS",
        "reference_id":null,
        "narration":"Acme Fund Transfer",
        "debit_account_number": "00228130001287",
        "batch_id":null,
        "status_details": {
          "description": "Payout is processed and the money has been credited into the beneficiaries account",
          "source": "beneficiary_bank",
          "reason": "payout_processed"
        }
        "created_at":1579175640,
        "fee_type": "",
      }
    }
  },
  "created_at":1579175674
}

Payout Updated

{
  "entity":"event",
  "account_id":"acc_BfVUrG6tDiL7H0",
  "event":"payout.updated",
  "contains":[
    "payout"
  ],
  "payload":{
    "payout":{
      "entity":{
        "id":"pout_1Aa00000000001",
        "entity":"payout",
        "fund_account_id":"fa_1Aa00000000001",
        "amount":2000000,
        "currency":"INR",
        "notes":{
          "note_key 1":"Tea. Earl Gray. Hot.",
          "note_key 2":"Tea. Earl Gray. Decaf."
        },
        "fees":1062,
        "tax":162,
        "status":"processed",
        "purpose":"refund",
        "utr":"933815233814",
        "mode":"IMPS",
        "reference_id":null,
        "narration":"Acme Fund Transfer",
        "debit_account_number": "00228130001287",
        "batch_id":null,
        "status_details": {
          "description": "Payout is processed and the money has been credited into the beneficiaries account",
          "source": "beneficiary_bank",
          "reason": "payout_processed"
        }
        "created_at":1579863747,
        "fee_type": ""
      }
    }
  },
  "created_at":1579863747
}

Payout Reversed

{
  "entity":"event",
  "account_id":"acc_BfVUrG6tDiL7H0",
  "event":"payout.reversed",
  "contains":[
    "payout"
  ],
  "payload":{
    "payout":{
      "entity":{
        "id":"pout_1Aa00000000001",
        "entity":"payout",
        "fund_account_id":"fa_1Aa00000000001",
        "amount":212,
        "currency":"INR",
        "notes":{
          "note_key 1":"Tea. Earl Gray. Hot.",
          "note_key 2":"Tea. Earl Gray. Decaf."
        },
        "fees":9,
        "tax":2,
        "status":"reversed",
        "purpose":"payout",
        "utr":"qwer12uijaaasssd",
        "mode":"IMPS",
        "reference_id":null,
        "narration":"Acme Fund Transfer",
        "debit_account_number": "00228130001287",
        "batch_id":null,
        "status_details": {
          "description": "Beneficiary bank systems are offline, please retry after 30 min",
          "source": "beneficiary_bank",
          "reason": "beneficiary_bank_offline"
        }
        "created_at":1580118057,
        "fee_type": ""
      }
    }
  },
  "created_at":1580118468
}

Payout Failed

{
  "entity": "event",
  "account_id": "acc_BfVUrG6tDiL7H0",
  "event": "payout.failed",
  "contains": [
    "payout"
  ],
  "payload": {
    "payout": {
      "entity": {
        "id": "pout_1Aa00000000001",
        "entity": "payout",
        "fund_account_id": "fa_1Aa00000000001",
        "amount": 100,
        "currency": "INR",
        "notes": {
          "note_key 1": "Tea. Earl Gray. Hot.",
          "note_key 2": "Tea. Earl Gray. Decaf."
        },
        "fees": 0,
        "tax": 0,
        "status": "failed",
        "purpose": "payout",
        "utr": "qwer12ui3323a22d",
        "mode": "IMPS",
        "reference_id": null,
        "narration": "Acme Fund Transfer",
        "debit_account_number": "00228130001287",
        "batch_id": null,
        "status_details":  {
          "description": "Payout failed as the beneficiary account is closed. Please contact the beneficiary bank",
          "source": "beneficiary_bank",
          "reason": "bank_account_closed"
        }
        "created_at": 1580120202,
        "fee_type": ""
      }
    }
  },
  "created_at": 1580120247
}

Payout Downtime Started

Handy Tips

The payout.downtime.started webhook is applicable for RTGS and NEFT modes also.