Payout Status

API Version: 3.0.0

Generate an API key for Payouts by navigating to Payouts → API Keys → Add new API key.

Use this endpoint to check the current status of a payout transaction. You need the reference ID from the original payout request.

Endpoint

Method	URL
GET	`https://payout.payorc.com/v1/status/:reference_id`

Headers

Header	Type	Required	Description
`Authorization`	String	Yes	Bearer token generated from the Create Token API

Path Parameters

Parameter	Type	Required	Description
`reference_id`	String	Yes	Your `reference_no` from the original transfer request

Code Examples

curl --location 'https://payout.payorc.com/v1/status/12345' \
--header 'Authorization: Bearer {{payout-bearer-token}}'

Response — Success (200)

{
    "data": {
        "transaction_id": "PY251209188937900001",
        "status": "SUCCESS",
        "reference_no": "12345",
        "amount": "100.00",
        "currency": "INR",
        "payment_mode": "NEFT",
        "date": "2026-02-17 16:46:32",
        "remark": "Test",
        "reason": "",
        "bank_reference_no": "KVBLH00244742734",
        "beneficiary": {
            "account_number": "200060539673",
            "account_type": "SA",
            "ifsc": "INDB0000539",
            "name": "John Doe",
            "email": "[email protected]",
            "mobile": "9999999999",
            "mmid": "",
            "lei_code": "",
            "nre_flag": "EX",
            "branch": ""
        }
    },
    "message": "Payout status retrieved successfully",
    "status": "success",
    "code": "00"
}

Response Fields

Field	Type	Description
`data`	Object	Contains payout transaction details
`data.transaction_id`	String	Unique payout transaction ID generated by PayOrc
`data.status`	String	Current status — `QUEUED`, `PROCESSING`, `SUCCESS`, `FAILED`, or `CANCELLED`
`data.reference_no`	String	Merchant's unique reference number sent during payout request
`data.amount`	String	Payout amount
`data.currency`	String	Transaction currency (`INR`)
`data.payment_mode`	String	Mode of transfer (e.g., `NEFT`, `IMPSP2A`, `RTGS`)
`data.date`	String	Transaction timestamp (`YYYY-MM-DD HH:mm:ss`)
`data.remark`	String	Remark sent during payout request
`data.reason`	String	Failure reason (when `status` is `FAILED`)
`data.bank_reference_no`	String	UTR or bank reference number for NEFT/IMPS/RTGS
`data.beneficiary`	Object	Beneficiary details object
`data.beneficiary.account_number`	String	Beneficiary bank account number
`data.beneficiary.account_type`	String	Account type (`SA` = Savings Account, `CA` = Current Account)
`data.beneficiary.ifsc`	String	IFSC code of the beneficiary bank
`data.beneficiary.name`	String	Beneficiary name
`data.beneficiary.email`	String	Beneficiary email address
`data.beneficiary.mobile`	String	Beneficiary mobile number
`data.beneficiary.mmid`	String	MMID (Mobile Money Identifier) if used
`data.beneficiary.lei_code`	String	LEI code for corporate beneficiaries, if applicable
`data.beneficiary.nre_flag`	String	`EX` or empty string
`data.beneficiary.branch`	String	Beneficiary bank branch name
`message`	String	API response message
`status`	String	API response status (`success` / `fail`)
`code`	String	Response code (`00` for success)

Response — Error (4xx)

{
    "message": "Invalid reference number",
    "status": "fail",
    "code": "E0044"
}

Error Response Fields

Field	Type	Description
`message`	String	Response description
`status`	String	API call status (`success` / `fail`)
`code`	String	Response code

Payout Status Values

Status	Description
`QUEUED`	Received and queued for processing
`PROCESSING`	Currently being processed
`SUCCESS`	Successfully completed
`FAILED`	Failed — check `reason` field
`CANCELLED`	Cancelled

If the status is FAILED, check the reason field for details on why the transaction failed.

Payout Status

On this page