Payout Status Details

Notify your beneficiaries of their payout details, and know how to troubleshoot when a payout status does not seem right.


Payout Status details are returned when a payout is created and moves to another state.

Status details are sent as part of the fetch payout API response and webhook payloads. It provides additional details about each payout status. A payout update webhook is fired every time an attribute in status details changes.

It also provides information about payouts in the processing state. If a payout is in the processing state due to deemed success, NEFT/RTGS off hours, and so on; such details are available via Status Details. You can use the information in this object to keep your beneficiaries informed.

Handy Tips

The status details object in the payouts' API response gives details about the exact reason for a payout state and the next steps to be taken. Please share this information with your developers.

Watch Out!

The 'failure_reason', 'queueing_details', and 'cancellation_details' fields, along with the 'error' object would be deprecated from the API response in a few days after enablement to reduce redundancy.

Below are the sample error code and the complete error response that appears as part of the status details.

{
"status_details": {
"description": "IMPS is not enabled on beneficiary account, Retry with different mode",
"source": "beneficiary_bank",
"reason": "imps_not_allowed",
}
}

description

string A description for the error. For example, IMPS is not enabled on beneficiary account, Retry with different mode.

source

string Possible values:

  • gateway: Technical error at Razorpay partner bank.
  • beneficiary_bank: Technical error at beneficiary bank.
  • business: Merchant action required.
  • internal: Technical error at Razorpay's server.

reason

string The error reason. For example, imps_not_allowed.

A sample complete payout status response code is as given below:

{
"id": "pout_00000000000001",
"entity": "payout",
"fund_account_id": "fa_00000000000001",
"amount": 1000000,
"currency": "INR",
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"fees": 0,
"tax": 0,
"status": "failed",
"utr": null,
"mode": "IMPS",
"purpose": "refund",
"reference_id": "Acme Transaction ID 12345",
"narration": "Acme Corp Fund Transfer",
"batch_id": null,
"failure_reason": "IMPS is not enabled on Beneficiary Account",
"created_at": 1545383037,
"status_details": {
"description": "IMPS is not enabled on beneficiary account, Retry with different mode",
"source": "beneficiary_bank",
"reason": "imps_not_allowed",
}
}

All the reasons for any payout state appear at the

of the code. The below table lists out the explanations for the sources.

SourceExplanation
gatewayTechnical error at Razorpay partner bank.
beneficiary_bankTechnical error at beneficiary bank.
businessMerchant action required.
internalTechnical error at Razorpay's server.

to view various payout statuses, and suggests the possible steps you can take to proceed further.

Last Updated on 22nd November, 2022.

You can get notified about these payout statuses and states instantly when you have configured the respective webhooks for it. Webhook notifications reduce the delay in information, and you can choose what states you want to be notified about.

We recommend

.