Get Payouts

API to retrieve the payout (fund withdrawal) transactions for the authenticated user. It returns details such as amount, payment mode, current status, bank name, transaction ID, and applicable charges. The response includes the most recent 20 transactions.

Request

curl --location 'https://api.upstox.com/v2/user/payments/payout' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'

Additional samples in various languages are available in the Sample Code section on this page.

Responses

• 200
• 400

---

Response Body

{
    "status": "success",
    "data": [
        {
            "amount": 16995.00,
            "mode": "NEFT",
            "status": "COMPLETED",
            "last_updated_at": "2026-04-19 13:25:56",
            "bank_name": "AXIS BANK",
            "transaction_id": "qws_0426_9680091",
            "reason": "",
            "total_charges": 23.60,
            "charges_category": "BASIC"
        },
        {
            "amount": 10000.00,
            "mode": "IMPS",
            "status": "TRANSFER_IN_PROGRESS",
            "last_updated_at": "2026-04-19 12:30:00",
            "bank_name": "ICICI BANK",
            "transaction_id": "imps_0426_7654321",
            "reason": "",
            "total_charges": 11.80,
            "charges_category": "BASIC"
        }
    ]
}

Name	Type	Description
status	string	Outcome of the request.
data	array	List of payout transaction records.
data[].amount	number	Transaction amount in rupees.
data[].mode	string	Payment mode. For e.g. NEFT, RTGS, IMPS, QUARTERLY_WITHDRAWAL etc.
data[].status	string	Current status of the payout. One of RECEIVED, VALIDATING, APPROVED, TRANSFER_IN_PROGRESS, COMPLETED, REJECTED, DEEMED_SUCCESS.
data[].last_updated_at	string	Date and time of the last status update in yyyy-MM-dd HH:mm:ss format.
data[].bank_name	string	Name of the bank associated with the transaction.
data[].transaction_id	string	Unique identifier for the transaction.
data[].reason	string	Reason message when a transaction is rejected or deemed success.
data[].total_charges	number	Total charges levied for the transaction in rupees.
data[].charges_category	string	Charges plan category. One of BASIC, PLUS in case of Net Banking and Instant Transfers.

Error codes

Errors follow the standard API error format. Ensure the request is authenticated.

Sample Code

Get payouts

Python

import requests

url = 'https://api.upstox.com/v2/user/payments/payout'
headers = {
    'accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}',
}
print(requests.get(url, headers=headers).json())

Node.js

const axios = require('axios');
axios.get('https://api.upstox.com/v2/user/payments/payout', {
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer {your_access_token}',
  },
}).then(r => console.log(r.data));

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpRequest req = HttpRequest.newBuilder()
                .uri(URI.create("https://api.upstox.com/v2/user/payments/payout"))
                .header("accept", "application/json")
                .header("Authorization", "Bearer {your_access_token}")
                .GET()
                .build();
        System.out.println(HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()).body());
    }
}

PHP

<?php
$url = 'https://api.upstox.com/v2/user/payments/payout';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'Authorization: Bearer {your_access_token}',
]);
echo curl_exec($ch);
curl_close($ch);

Loading...