Payouts

The Payout APIs provide details about payout transactions, including the amount, currency, and status.

Download Payouts OpenAPI Document

End Points

GET

/payouts/{payout_id}/transactions

Attribute

payout_id

string

A unique identifier for the payout.

amount

string

The payout amount.

currency

string

The currency of the payout amount, represented by a 3-letter ISO currency code
(e.g., INR).

status

string

The status of the payout. It can be initiated, paid or failed.

failure_code

string

The failure code of the payout.

failure_message

string

The failure message of the payout.

statement_descriptor

string

The payout descriptor.

initiated_time

string

The timestamp (milliseconds) indicating when the payout was initiated.

processed_date

string

The date on which payout was settled.

type

string

The payout type. It can be: deposit or withdrawal.

payout_bank_reference_id

string

The bank reference identifier of the payout.

bank_account_details

object

Show Sub-Attributes

bank_name

string

Name of the destination bank for the payout.

account_number_last_four_digits

string

The last four digits of the payout account number.

account_holder_name

string

The account holder name of the payout processed account.

routing_number

string

The IFSC code of the payout processed account number.

{
    "payout_id": "193000002315107",
    "amount": "100.90",
    "currency": "INR",
    "status": "paid",
    "failure_code": "",
    "failure_message": "",
    "statement_descriptor": "ZOHO PAYMENTS",
    "initiated_time": "1750681308996",
    "processed_date": "Jun 23, 2025",
    "type": "deposit",
    "payout_bank_reference_id": "040956641001",
    "bank_account_details": {
        "bank_name": "ICICI BANK LIMITED",
        "account_number_last_four_digits": "1193",
        "account_holder_name": "Zylker",
        "routing_number": "ICIC0000001"
    }
}

Retrieve Payouts List

Used to retrieve the details of all the payouts.
OAuth Scope : ZohoPay.payouts.READ

Query Parameters

account_id

long

(Required)

The Zoho Payments account ID.

status

string

Status can be: Status.All, Status.Initiated, Status.Paid or Status.Failed.

filter_by

string

Filter the payouts list using date intervals: PayoutDate.Today, PayoutDate.ThisWeek, PayoutDate.ThisMonth, PayoutDate.ThisQuarter, PayoutDate.ThisHalfYear, PayoutDate.ThisYear, PayoutDate.PreviousDay, PayoutDate.PreviousWeek, PayoutDate.PreviousMonth, PayoutDate.PreviousQuarter, PayoutDate.PreviousHalfYear, PayoutDate.PreviousYear, PayoutDate.CustomDate, PayoutDate.Last_7_Days, PayoutDate.Last_30_Days, PayoutDate.Last_90_Days.

from_date

string

If the given filter_by is PayoutDate.CustomDate, this param is required. (e.g., 2024-06-06)

to_date

string

If the given filter_by is PayoutDate.CustomDate, this param is required. (e.g., 2024-08-30)

per_page

integer

Indicates the number of payouts to list per page. The default value is 25 per page, and the maximum limit is 200.

page

integer

Indicates the page number of the payouts list. (e.g., 1)

Request Example

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/payouts?account_id=23137556")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://payments.zoho.in/api/v1/payouts?account_id=23137556', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("payments.zoho.in")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v1/payouts?account_id=23137556", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "payments.zoho.in",
  "port": null,
  "path": "/api/v1/payouts?account_id=23137556",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://payments.zoho.in/api/v1/payouts?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "payouts": [
        {
            "payout_id": "193000002315107",
            "amount": "100.90",
            "currency": "INR",
            "status": "paid",
            "failure_code": "",
            "failure_message": "",
            "statement_descriptor": "ZOHO PAYMENTS",
            "initiated_time": "1750681308996",
            "processed_date": "Jun 23, 2025",
            "type": "deposit",
            "payout_bank_reference_id": "040956641001",
            "bank_account_details": {
                "bank_name": "ICICI BANK LIMITED",
                "account_number_last_four_digits": "1193",
                "account_holder_name": "Zylker",
                "routing_number": "ICIC0000001"
            }
        },
        {...},
        {...}
    ]
}

Retrieve Payout

Used to retrieve the details of a specific payout.
OAuth Scope : ZohoPay.payouts.READ

Path Parameters

payout_id

long

(Required)

The unique identifier created for the payout.

Query Parameters

account_id

long

(Required)

The Zoho Payments account ID.

Request Example

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/payouts/193000002315107?account_id=23137556")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://payments.zoho.in/api/v1/payouts/193000002315107?account_id=23137556', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("payments.zoho.in")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v1/payouts/193000002315107?account_id=23137556", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "payments.zoho.in",
  "port": null,
  "path": "/api/v1/payouts/193000002315107?account_id=23137556",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://payments.zoho.in/api/v1/payouts/193000002315107?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "payout": {
        "payout_id": "193000002315107",
        "amount": "100.90",
        "processing_fee": 0,
        "currency": "INR",
        "status": "paid",
        "failure_code": "",
        "failure_message": "",
        "statement_descriptor": "ZOHO PAYMENTS",
        "initiated_time": 1718778179,
        "processed_date": 1718778557,
        "type": "deposit",
        "fee": "0.00",
        "fee_rate": "0.00",
        "payout_method": "standard",
        "payout_bank_reference_id": "040956641001",
        "comments": [
            {
                "comment_id": "193000001315107",
                "amount": "100.90",
                "operation_type": "updated",
                "action_type": "paid",
                "type": "system_generated",
                "description": "Payout initiated.",
                "created_by": "Zoho Payments",
                "created_time": 1751876104
            }
        ],
        "transaction_summary": {
            "charge": {
                "transaction_type": "charge",
                "count": 4,
                "net_amount": 3.98,
                "fee": -0.02,
                "tax": 0,
                "amount": 4
            },
            "refund": {
                "transaction_type": "refund",
                "count": 0,
                "net_amount": 0,
                "fee": 0,
                "tax": 0,
                "amount": 0
            },
            "adjustment": {
                "transaction_type": "adjustment",
                "count": 0,
                "net_amount": 0,
                "fee": 0,
                "tax": 0,
                "amount": 0
            },
            "total_amount": "100.90"
        },
        "account_details": {
            "transaction_type": "ICICI BANK LIMITED",
            "account_holder": "Zylker",
            "account_number_last_four_digits": "1193",
            "routing_number": "ICIC0000001",
            "type": "bank_account",
            "country": "IN",
            "currency": "INR"
        }
    }
}

Retrieve Payout Transactions

Used to retrieve the details of all the transactions associated with a specific payout.
OAuth Scope : ZohoPay.payouts.READ

Path Parameters

payout_id

long

(Required)

The unique identifier created for the payout.

Query Parameters

account_id

long

(Required)

The Zoho Payments account ID.

Request Example

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/payouts/193000002315107/transactions?account_id=23137556")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://payments.zoho.in/api/v1/payouts/193000002315107/transactions?account_id=23137556', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("payments.zoho.in")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v1/payouts/193000002315107/transactions?account_id=23137556", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "payments.zoho.in",
  "port": null,
  "path": "/api/v1/payouts/193000002315107/transactions?account_id=23137556",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://payments.zoho.in/api/v1/payouts/193000002315107/transactions?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "transactions": [
        {
            "payout_id": "193000002315107",
            "transaction_id": "193000001315999",
            "parent_transaction_id": "",
            "net_amount": 1,
            "amount": 1,
            "fee": 0,
            "tax": 0,
            "transaction_type": "charge",
            "transaction_time": "charge",
            "currency": "INR",
            "customer_id": "1930000000724207",
            "customer_name": "Charles",
            "description": "Charles"
        },
        {...},
        {...}
    ]
}