API Documentation - shivapayu

Create Payout Order

POST https://admin.shivapayu.com/api/payout/v1/createOrder

Parameters

Parameter	Type	Description	Required
api_token	string	API token for authentication.	Yes
amount	numeric	Payout amount.	Yes
transfer_mode	string	IMPS, NEFT, RTGS	Yes
externalTxnId	string	Unique transaction ID generated by client.	No
payee_name	string	Beneficiary full name.	Yes
payee_account	numeric	Beneficiary bank account number.	Yes
payee_ifsc	string	Beneficiary bank IFSC.	Yes
payee_ac_type	string	savings or current	Yes
payee_bank_name	string	Beneficiary bank name.	Yes

Success Response

{
  "data": {
    "status": "success",
    "message": "Fund Transfer Successful",
    "amount": 1500,
    "txnStatusDesc": "success",
    "bank_ref_no": "9876543210",
    "externalTxnId": "ext_txn_123456",
    "payeeName": "Demo User",
    "payeeAccount": "123456789012",
    "payeeIfsc": "TEST0000123"
  },
  "status": 200
}

Failure Response (Duplicate ID)

{
  "status": "failure",
  "message": "The external txn id has already been taken."
}

Failure Response (Transaction Failed)

{
  "data": {
    "status": "failure",
    "message": "Payout failed and refunded",
    "amount": 100,
    "externalTxnId": "69886888311"
  },
  "status": 400
}

Callback (Merchant)

Callback is sent to the merchant's call_back_url after final transaction status.

Parameters

Parameter	Type	Description	Required
type	string	Transaction type (e.g. payout)	Yes
externalTxnId	string	Client transaction ID	Yes
status	string	success or failure	Yes
amount	numeric	Transaction amount	Yes
utr	string	Bank UTR / Reference number	Yes
message	string	Transaction status message	Yes

Callback Payload

{
  "type": "payout",
  "externalTxnId": "ext_txn_123456",
  "status": "success",
  "amount": 1500,
  "utr": "987654321098",
  "message": "Payout success"
}

Payout Status Check

This API allows merchants to manually check the current status of a payout using the externalTxnId. This is useful when callback is delayed or not received.

GET https://admin.shivapayu.com/api/payout/v1/status-check

Parameters

Parameter	Type	Description	Required
api_token	string	Merchant API token for authentication.	Yes
type	string	Must be `status-check`	Yes
externalRef	string	Client transaction ID (externalTxnId)	Yes

Success Response

{
  "status": "SUCCESS",
  "txnStatus": "SUCCESS",
  "amount": 100,
  "utr": "600932368113",
  "externalRef": "122311",
  "message": "Transaction successful"
}

Pending Response

{
  "status": "PENDING",
  "txnStatus": "PENDING",
  "amount": 100,
  "externalRef": "122311",
  "message": "Transaction is under process"
}

Failure Response

{
  "status": "FAILED",
  "txnStatus": "FAILED",
  "message": "Transaction failed or not found"
}