Payout Payloads🔗

The payload remains the same irrespective of the fund_account_type to which payout was made. That is, the payload is the same whether the payout was made to a bank account, vpa or card.

payout.pending all payouts: Triggered whenever a payout moves to the pending state. The payout remains in this state till you approve or reject it.
payout.rejected all payouts: Triggered whenever a payout moves to the rejected state. The payout was rejected by someone from your team.
payout.queued all payouts: Triggered whenever a payout moves to the queued state. A payout goes to the queued state when you do not have sufficient balance to process the payout. This can happen when you create the payout or when you approve a payout in the pending state.
payout.initiated all payouts: Triggered when the payout moves to the processing state when the payout is created or from the queued state when sufficient funds are available to process the payout.
payout.processed all payouts: Triggered when a payout moves to the processed state. This happens when the payout is processed by the contact's bank.
payout.updatedall payouts: Triggered whenever there is a change in the payout entity. For example, when we receive the UTR for the payout from the bank. For NEFT transactions, this webhook is fired within 90 seconds. For IMPS and UPI transactions, this webhook is generally fired immediately.
payout.reversed all payouts: Triggered whenever a payout fails and the amount is returned to your business account.
payout.failed current account payouts: This webhook event is available only when a payout is made using your current account balance. This event is triggered when a payout is failed by our current account partner bank.

Order of Events🔗

Ideally, you should receive webhooks in the following order:

payout.pending (if you have Approval Workflow enabled on your account)
payout.queued (in case your business account does not have sufficient balance to process the payout)
payout.initiated
payout.processed or payout.reversed

However, this is not guaranteed. You should configure your Webhook URL to not expect delivery of these events in this order and handle such scenarios.

The processed and reversed states are terminal states for a payout. Their corresponding webhooks payout.processed or payout.reversed indicate this state change. Any webhook received after these should be ignored.

Payout Pending🔗

 payout.pending
Copy{
  "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",
        "batch_id":null,
        "failure_reason":null,
        "created_at":1580808301,
        "fee_type": "",
        "error": {
          "description": null,
          "source": null,
          "reason": null
        }
      }
    }
  },
  "created_at":1580808301
}

Payout Rejected🔗

 payout.rejected
Copy{
  "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",
        "batch_id":null,
        "failure_reason":null,
        "created_at":1581512005,
        "fee_type": "",
        "error": {
          "description": null,
          "source": null,
          "reason": null
        }
      }
    }
  },
  "created_at":1581512006
}

Payout Queued🔗

 payout.queued
Copy{
  "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",
        "batch_id":null,
        "failure_reason":null,
        "created_at":1580119445,
        "fee_type": "",
        "error": {
          "description": null,
          "source": null,
          "reason": null
        }
      }
    }
  },
  "created_at":1580119445
}

Payout Initiated🔗

 payout.initiated
Copy{
  "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",
        "batch_id":null,
        "failure_reason":null,
        "created_at":1579865132,
        "fee_type": "",
        "error": {
          "description": null,
          "source": null,
          "reason": null
        }
      }
    }
  },
  "created_at":1579865132
}

Payout Processed🔗

 payout.processed
Copy{
  "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",
        "batch_id":null,
        "failure_reason":null,
        "created_at":1579175640,
        "fee_type": "",
        "error": {
          "description": null,
          "source": null,
          "reason": null
        }
      }
    }
  },
  "created_at":1579175674
}

Payout Updated🔗

 payout.updated
Copy{
  "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",
        "batch_id":null,
        "failure_reason":null,
        "created_at":1579863747,
        "fee_type": "",
        "error": {
          "description": null,
          "source": null,
          "reason": null
        }
      }
    }
  },
  "created_at":1579863747
}

Payout Reversed🔗

 payout.reversed
Copy{
  "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",
        "batch_id":null,
        "failure_reason":"Payout failed. Contact support for help",
        "created_at":1580118057,
        "fee_type": "",
        "error": {
          "description": null,
          "source": null,
          "reason": null
        }
      }
    }
  },
  "created_at":1580118468
}

Payout Failed🔗

 payout.failed
Copy{
  "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",
        "batch_id": null,
        "failure_reason": "Payout failed. Contact support for help",
        "created_at": 1580120202,
        "fee_type": "",
        "error": {
          "description": null,
          "source": null,
          "reason": null
        }
      }
    }
  },
  "created_at": 1580120247
}

Transaction Payloads🔗

transaction.created

Triggered whenever you make:

A Payout (virtual account or current account).
Add funds to your RazorpayX account (virtual account or current account).
Any kind of transaction (ATM transaction, cash withdrawal, netbanking transfer, encashed cheque) on your current account.

Transaction Created🔗

 Payload: Payout Payload: Add Funds (Direct Bank Transfer)
Copy{
  "entity":"event",
  "account_id":"acc_1Aa00000000001",
  "event":"transaction.created",
  "contains":[
    "transaction"
  ],
  "payload":{
    "transaction":{
      "entity":{
        "id":"txn_1Aa00000000001",
        "entity":"transaction",
        "account_number":"7878780080749731",
        "amount":218,
        "currency":"INR",
        "credit":0,
        "debit":218,
        "balance":4242,
        "source":{
          "id":"pout_1Aa00000000001",
          "entity":"payout",
          "fund_account_id":"fa_1Aa00000000001",
          "amount":100,
          "notes":[],
          "fees":118,
          "tax":18,
          "status":"processing",
          "utr":null,
          "mode":"IMPS",
          "created_at":1565343608
        },
        "created_at":1565343678
      }
    }
  },
  "created_at":1565343678
}
Copy{
"entity": "event",
"account_id": "acc_00000000000001",
"event": "transaction.created",
"contains": ["transaction"],
"payload": {
  "transaction": {
    "entity": {
      "id": "txn_00000000000001",
      "entity": "transaction",
      "account_number": "1121431121541121",
      "amount": 10000000,
      "currency": "INR",
      "credit": 10000000,
      "debit": 0,
      "balance": 10000000,
      "source": {
        "id": "bt_00000000000001",
        "entity": "bank_transfer",
        "payer_name": "Saurav Kumar",
        "payer_account": "6543266545411243",
        "payer_ifsc": "UTIB0000001",
        "mode": "NEFT",
        "bank_reference": "AXIR000000000001",
        "amount": 10000000
      },
      "created_at": 1545125568
    }
  }
 },
"created_at": 1545125568
}

RazorpayX - Webhook Payloads