Payment Session AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

The Payment Session represents a single payment initiation using Zoho Payments. It includes key details such as the session ID, amount, currency, and the time when the session was created.
Each Payment Session will be valid for 15 minutes only.

Download Payment Session OpenAPI Document

End Points

POST

/paymentsessions

GET

/paymentsessions/{payments_session_id}

Attribute

payments_session_id

string

The Payment Session ID is a unique identifier for the session.

currency

string

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

amount

string

Amount with which payment session was created

created_time

long

The timestamp (milliseconds) indicating when the payment session was created.

expiry_time

long

The timestamp (milliseconds) indicating when the payment session will expire.

meta_data

array

Provides additional metadata that can be useful for storing supplementary information. The maximum size of the array can be 5.
Avoid storing sensitive information, including bank account numbers, card details, or personally identifiable information (PII) such as phone numbers or email addresses, in metadata fields. Use metadata only for non-sensitive identifiers, for instance:

Order IDs, Customer IDs, and other identifiers for easy reference.
Any additional identifiers or data stored in key-value pairs that may be helpful for future reference.

Show Sub-Attributes

key

string

A unique key used to store metadata for reference. The maximum length of the key can be 20 characters.

value

string

The value associated with the key for reference. The maximum length of the value can be 500 characters.

description

string

The description of the payment session. The maximum length of the description can be 500 characters.

invoice_number

string

The invoice number of the payment session. The maximum length of the invoice number can be 50 characters.

reference_number

string

A reference to identify the transaction. The maximum length can be 50 characters.

max_retry_count

integer

The maximum number of retry payment attempts allowed for this session. The value must be between 1 and 5. Default max retry count is 5.

configurations

object

Allows you to customise the payment experience for your customers.

Show Sub-Attributes

allowed_payment_methods

array

A list of payment methods allowed for this payment session. Accepted values are card, upi, netbanking, wallet and bank_transfer.

hosted_page_parameters

object

Hosted Pages settings. When included, the create response includes an access_key to open the hosted checkout.

Show Sub-Attributes

phone_country_code

string

ISO country code for the customer phone (e.g. IN for India).

phone

string

Customer phone number.

name

string

Customer name.

Customer email address.

description

string

(Required)

Displayed to the customer on the hosted checkout page.

success_url

uri

(Required)

HTTPS URL to redirect the customer after a successful payment.

failure_url

uri

(Required)

HTTPS URL to redirect after a failed payment.

udf1

string

Optional user-defined field.

udf2

string

Optional user-defined field.

udf3

string

Optional user-defined field.

udf4

string

Optional user-defined field.

udf5

string

Optional user-defined field.

{
    "payments_session_id": "2000000012001",
    "currency": "INR",
    "amount": "100.50",
    "created_time": 1708950672,
    "expiry_time": 1708951572,
    "meta_data": [
        {
            "key": "Key1",
            "value": "Value1"
        }
    ],
    "description": "Payment for Order #12345",
    "invoice_number": "INV-12345",
    "reference_number": "reference_123",
    "max_retry_count": 3,
    "access_key": "ZWFybmVzdGVuY3J5cHRlZHRva2Vu",
    "configurations": {
        "allowed_payment_methods": [
            "upi",
            "card"
        ],
        "hosted_page_parameters": {
            "phone_country_code": "IN",
            "phone": "9876543210",
            "name": "Charles",
            "email": "xxx@abc.com",
            "description": "Payment for Order #12345",
            "success_url": "https://example.com/success",
            "failure_url": "https://example.com/failure",
            "udf1": "example_udf_1",
            "udf2": "example_udf_2",
            "udf3": "example_udf_3",
            "udf4": "example_udf_4",
            "udf5": "example_udf_5"
        }
    }
}

Create Payment Session AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

This API endpoint allows you to create a new Payment Session in Zoho Payments. Initiate a payment with a specific amount and currency.
OAuth Scope : ZohoPay.payments.CREATE

Arguments

amount

double

(Required)

The amount to be charged, with support for decimal places.

currency

string

(Required)

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

expires_in

integer

The expiration time for the payment session in seconds. The value must be between 300 (5 minutes) and 900 (15 minutes). Default expiry is 900 seconds (15 minutes).

transfer_details

array

Indicates the way an incoming payment is split among connected accounts. This is applicable only if the feature is enabled. Each entry includes a connected_account_id and an amount. The number of entries can range from 0 to 20.

Show Sub-Attributes

connected_account_id

long

The unique identifier of the connected account.

amount

double

The amount to be transferred to the connected account.

meta_data

array

Order IDs, Customer IDs, and other identifiers for easy reference.
Any additional identifiers or data stored in key-value pairs that may be helpful for future reference.

Show Sub-Attributes

key

string

A unique key used to store metadata for reference. The maximum length of the key can be 20 characters.

value

string

The value associated with the key for reference. The maximum length of the value can be 500 characters.

description

string

(Required)

The description of the payment session. The maximum length of the description can be 500 characters.

invoice_number

string

The invoice number of the payment session. The maximum length of the invoice number can be 50 characters.

reference_number

string

A reference to identify the transaction. The maximum length can be 50 characters.

max_retry_count

integer

The maximum number of retry payment attempts allowed for this session. The value must be between 1 and 5. Default max retry count is 5.

configurations

object

Allows you to customise the payment experience for your customers.

Show Sub-Attributes

allowed_payment_methods

array

A list of payment methods allowed for this payment session. Accepted values are card, upi, netbanking, wallet and bank_transfer.

hosted_page_parameters

object

Hosted Pages settings. When included, the create response includes an access_key to open the hosted checkout.

Show Sub-Attributes

phone_country_code

string

ISO country code for the customer phone (e.g. IN for India).

phone

string

Customer phone number.

name

string

Customer name.

Customer email address.

description

string

(Required)

Displayed to the customer on the hosted checkout page.

success_url

uri

(Required)

HTTPS URL to redirect the customer after a successful payment.

failure_url

uri

(Required)

HTTPS URL to redirect after a failed payment.

udf1

string

Optional user-defined field.

udf2

string

Optional user-defined field.

udf3

string

Optional user-defined field.

udf4

string

Optional user-defined field.

udf5

string

Optional user-defined field.

Query Parameters

account_id

long

(Required)

The Zoho Payments account ID.

Request Example

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

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

HttpResponse<String> response = Unirest.post("https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556")
  .header("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .header("content-type", "application/json")
  .body("{\"field1\":\"value1\",\"field2\":\"value2\"}")
  .asString();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

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

const settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556",
  "method": "POST",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  },
  "processData": false,
  "data": "{\"field1\":\"value1\",\"field2\":\"value2\"}"
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

import http.client

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

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/paymentsessions?account_id=23137556", payload, headers)

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

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

const http = require("https");

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

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.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

const unirest = require("unirest");

const req = unirest("POST", "https://payments.zoho.in/api/v1/paymentsessions");

req.query({
  "account_id": "23137556"
});

req.headers({
  "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
  "content-type": "application/json"
});

req.type("json");
req.send({
  "field1": "value1",
  "field2": "value2"
});

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const request = require('request');

const options = {
  method: 'POST',
  url: 'https://payments.zoho.in/api/v1/paymentsessions',
  qs: {account_id: '23137556'},
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: {field1: 'value1', field2: 'value2'},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
request["content-type"] = 'application/json'
request.body = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"field1\":\"value1\",\"field2\":\"value2\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

<?php

$request = new HttpRequest();
$request->setUrl('https://payments.zoho.in/api/v1/paymentsessions');
$request->setMethod(HTTP_METH_POST);

$request->setQueryData([
  'account_id' => '23137556'
]);

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
  'content-type' => 'application/json'
]);

$request->setBody('{"field1":"value1","field2":"value2"}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

<?php

$client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{"field1":"value1","field2":"value2"}');

$request->setRequestUrl('https://payments.zoho.in/api/v1/paymentsessions');
$request->setRequestMethod('POST');
$request->setBody($body);

$request->setQuery(new http\QueryString([
  'account_id' => '23137556'
]));

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
  'content-type' => 'application/json'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

var client = new RestClient("https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556"),
    Headers =
    {
        { "Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556");
xhr.setRequestHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request POST \
  --url 'https://payments.zoho.in/api/v1/paymentsessions?account_id=23137556' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "amount": 100.5,
    "currency": "INR",
    "expires_in": 900,
    "transfer_details": [
        {
            "connected_account_id": 23137556,
            "amount": 10
        },
        {
            "connected_account_id": 23137556,
            "amount": 20.5
        }
    ],
    "meta_data": [
        {
            "key": "Key1",
            "value": "Value1"
        }
    ],
    "description": "Payment for Order #12345",
    "invoice_number": "INV-12345",
    "reference_number": "reference_123",
    "max_retry_count": 3,
    "configurations": {
        "allowed_payment_methods": [
            "upi",
            "card"
        ],
        "hosted_page_parameters": {
            "phone_country_code": "IN",
            "phone": "9876543210",
            "name": "Charles",
            "email": "xxx@abc.com",
            "description": "Payment for Order #12345",
            "success_url": "https://example.com/success",
            "failure_url": "https://example.com/failure",
            "udf1": "example_udf_1",
            "udf2": "example_udf_2",
            "udf3": "example_udf_3",
            "udf4": "example_udf_4",
            "udf5": "example_udf_5"
        }
    }
}

{
    "code": 0,
    "message": "success",
    "payments_session": {
        "payments_session_id": "2000000012001",
        "currency": "INR",
        "amount": "100.50",
        "created_time": 1708950672,
        "expiry_time": 1708951572,
        "meta_data": [
            {
                "key": "Key1",
                "value": "Value1"
            }
        ],
        "description": "Payment for Order #12345",
        "invoice_number": "INV-12345",
        "reference_number": "reference_123",
        "max_retry_count": 3,
        "access_key": "ZWFybmVzdGVuY3J5cHRlZHRva2Vu",
        "configurations": {
            "allowed_payment_methods": [
                "upi",
                "card"
            ],
            "hosted_page_parameters": {
                "phone_country_code": "IN",
                "phone": "9876543210",
                "name": "Charles",
                "email": "xxx@abc.com",
                "description": "Payment for Order #12345",
                "success_url": "https://example.com/success",
                "failure_url": "https://example.com/failure",
                "udf1": "example_udf_1",
                "udf2": "example_udf_2",
                "udf3": "example_udf_3",
                "udf4": "example_udf_4",
                "udf5": "example_udf_5"
            }
        }
    }
}

Retrieve Payment Session AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

This API endpoint allows you to retrieve the details of the latest payment session.
OAuth Scope : ZohoPay.payments.READ

Path Parameters

payments_session_id

long

(Required)

The Payment Session ID is a unique identifier for the session.

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/paymentsessions/173000002315107?account_id=23137556")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

HttpResponse<String> response = Unirest.get("https://payments.zoho.in/api/v1/paymentsessions/173000002315107?account_id=23137556")
  .header("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .asString();

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

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

const settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://payments.zoho.in/api/v1/paymentsessions/173000002315107?account_id=23137556",
  "method": "GET",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

import http.client

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

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

conn.request("GET", "/api/v1/paymentsessions/173000002315107?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/paymentsessions/173000002315107?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();

const unirest = require("unirest");

const req = unirest("GET", "https://payments.zoho.in/api/v1/paymentsessions/173000002315107");

req.query({
  "account_id": "23137556"
});

req.headers({
  "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
});

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://payments.zoho.in/api/v1/paymentsessions/173000002315107',
  qs: {account_id: '23137556'},
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://payments.zoho.in/api/v1/paymentsessions/173000002315107?account_id=23137556")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payments.zoho.in/api/v1/paymentsessions/173000002315107?account_id=23137556",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

<?php

$request = new HttpRequest();
$request->setUrl('https://payments.zoho.in/api/v1/paymentsessions/173000002315107');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData([
  'account_id' => '23137556'
]);

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
]);

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

<?php

$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://payments.zoho.in/api/v1/paymentsessions/173000002315107');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
  'account_id' => '23137556'
]));

$request->setHeaders([
  'Authorization' => 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

var client = new RestClient("https://payments.zoho.in/api/v1/paymentsessions/173000002315107?account_id=23137556");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://payments.zoho.in/api/v1/paymentsessions/173000002315107?account_id=23137556"),
    Headers =
    {
        { "Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://payments.zoho.in/api/v1/paymentsessions/173000002315107?account_id=23137556"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://payments.zoho.in/api/v1/paymentsessions/173000002315107?account_id=23137556");
xhr.setRequestHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

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

{
    "code": 0,
    "message": "success",
    "payments_session": {
        "payments_session_id": "2000000012001",
        "currency": "INR",
        "amount": "100.50",
        "status": "succeeded",
        "created_time": 1708950672,
        "expiry_time": 1708951572,
        "payments": [
            {
                "payment_id": "173000002314883",
                "status": "succeeded",
                "created_time": 1708950672
            }
        ],
        "meta_data": [
            {
                "key": "Key1",
                "value": "Value1"
            }
        ],
        "description": "Payment for Order #12345",
        "invoice_number": "INV-12345",
        "reference_number": "reference_123",
        "max_retry_count": 3,
        "configurations": {
            "allowed_payment_methods": [
                "upi",
                "card"
            ],
            "hosted_page_parameters": {
                "phone_country_code": "IN",
                "phone": "9876543210",
                "name": "Charles",
                "email": "xxx@abc.com",
                "description": "Payment for Order #12345",
                "success_url": "https://example.com/success",
                "failure_url": "https://example.com/failure",
                "udf1": "example_udf_1",
                "udf2": "example_udf_2",
                "udf3": "example_udf_3",
                "udf4": "example_udf_4",
                "udf5": "example_udf_5"
            }
        }
    }
}

Payment Session AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Attribute

Create Payment Session AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Query Parameters

Retrieve Payment Session AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Payment Session AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Create Payment Session AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Retrieve Payment Session AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab