Payout Status Details

Know about RazorpayX Payouts status details.

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.

Sample Code🔗

 Sample Error Response
Copy{
  "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.

Complete Payout Status Response Code🔗

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

Copy{
  "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",
  }
}

Payout Status Source🔗

Source	Explanation
`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.

Payout Status Details and Next Steps🔗

The table below lists the various payout statuses, and suggests the possible steps you can take to proceed further.

Status	Reason	Explanation	Next Step
Processing (RTGS)	`beneficiary_bank_confirmation_pending`	Confirmation of the credit to the beneficiary is pending from beneficiary bank. Please check the status after `date and time`.	Inform the customer of the delay, reason for the same and by when it will be cleared.
Processing (NEFT)	`beneficiary_bank_confirmation_pending`	Confirmation of the credit to the beneficiary is pending from beneficiary bank. Please check the status after `date and time`.	Inform the customer of the delay, reason for the same and by when it will be cleared.
Processing (UPI)	`beneficiary_bank_confirmation_pending`	Confirmation of the credit to the beneficiary is pending from the beneficiary bank. Please check the status after `date and time`.	Inform the customer of the delay, reason for the same and by when it will be cleared.
Processing (IMPS)	`beneficiary_bank_confirmation_pending`	Confirmation of the credit to the beneficiary is pending from beneficiary bank. Please check the status after `date and time`.	Inform the customer of the delay, reason for the same and by when it will be cleared.
Processing	`bank_window_closed (NEFT)`	The NEFT window for the day is closed. Please check the status on `date`.	Wait till the next window before reaching out to the support team/checking the status.
Processing	`bank_window_closed (RTGS)`	The RTGS window for the day is closed. Please check the status on `date`.	Wait till the next window before reaching out to the support team/checking the status.
Processing	`payout_bank_processing`	Payout is being processed by our partner bank. Please check the final status after some time.	Wait till the next window before reaching out to the support team/checking the status.
Pending	`pending_approval`	Workflow for the payout is pending approval from the approver(s).	Reach out to the approver(s) for getting the workflow approved. Refer Approval Workflow for more information.
Queued	`beneficiary_bank_down`	Payout is queued as State Bank of India systems is down.	NA
Queued	`npci_system_down`	Payout is queued as NPCI systems are down.	Retry after some time.
Queued	`low_balance`	Payout is queued as there is insufficient balance in your business account to process the payout.	Add funds to your account.
Processed	`payout_processed`	Payout is processed and the money has been credited into the beneficiary's account.	NA
reversed/failed	`gateway_technical_error`	Payout failed at partner bank. Please retry after 30 min.	Retry after 30 min.
reversed/failed	`beneficiary_bank_offline`	Beneficiary bank systems are offline, please retry after 30 min.	Retry after 30 min.
reversed/failed	`beneficiary_psp_offline`	Beneficiary PSP systems are offline, please retry after 30 mins.	Retry after 30 min.
reversed/failed	`bank_account_closed`	Payout failed as the beneficiary account is closed. Please contact the beneficiary bank.	Contact beneficiary bank.
reversed/failed	`transaction_limit_exceeded`	Payout amount greater than the limit supported by the beneficiary account.	Try with a lesser amount.
reversed/failed	`beneficiary_bank_failure`	Payout failed at the beneficiary bank due to technical issues. Please retry.	Retry after some time.
reversed/failed	`beneficiary_bank_rejected`	Payout rejected by the beneficiary bank. Please contact the beneficiary bank.	Contact beneficiary bank.
reversed/failed	`bank_account_frozen`	Payout failed as the beneficiary account is frozen. Please contact the beneficiary bank.	Contact beneficiary bank.
reversed/failed	`gateway_timeout`	Payout timed out at the partner bank. Please retry after 30 min.	Retry after 30 min.
reversed/failed	`imps_not_allowed`	IMPS is not enabled on the beneficiary account, please retry with different mode.	Try with different payment mode.
reversed/failed	`bank_account_invalid`	Payout failed due to invalid beneficiary account details.	Verify beneficiary account details.
reversed/failed	`invalid_ifsc_code`	Payout failed as the IFSC code is invalid. Please change the IFSC code and retry.	Verify IFSC Code and retry.
reversed/failed	`beneficiary_vpa_invalid`	UPI validation failed. If the UPI ID is valid, please retry after sometime.	Verify UPI and retry.
reversed/failed	`nre_bank_account`	Payout failed as the beneficiary account is an NRE account. Please contact the beneficiary bank.	Contact beneficiary bank.
reversed/failed	`server_error`	Payout failed due to technical failure. Please retry after 30 min.	Retry after 30 min.
reversed/failed	`bank_account_dormant`	Payout failed as the beneficiary account is dormat. Please contact the beneficiary bank.	Contact beneficiary bank.
reversed/failed	`gateway_down`	Payout failed as the partner bank is facing technical issues. Please retry.	Retry after some time.

ON THIS PAGE

Payout Status Details

Sample Code🔗

Complete Payout Status Response Code🔗

Payout Status Source🔗

Payout Status Details and Next Steps🔗

Related Information🔗