Distribution

Create Payment Session

Creates a unique payment session for a specified amount that can be shared with a customer.

How it works

The customer uses the payment link to make a payment through the selected payment method.
Once the payment is successfully completed, the partner receives a webhook notification for the session.
A single session can contain multiple transactions, where each transaction represents a payment attempt.
Customers can make multiple payment attempts using different payment methods.

Transaction details

Use the Get Session API to retrieve all transactions associated with a session. The status of each transaction can be retrieved using the Get Transaction API.

POST

billingSession

v1.0

generateBillingSession

Create Payment Session

curl --request POST \
  --url https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "returnUrl": "<string>",
  "billTo": {
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "items": [
    {
      "name": "<string>",
      "quantity": 123,
      "amount": 123,
      "attributes": [
        {
          "orderId": "<string>",
          "userId": "<string>",
          "clientId": "<string>"
        }
      ],
      "productReferenceId": "<string>",
      "description": "<string>",
      "hsnCode": "<string>",
      "shippable": false
    }
  ],
  "email": "<string>",
  "clientReferenceId": "<string>",
  "phoneNo": "+91-9876543210",
  "taxIdentity": "<string>",
  "gstIdentity": "<string>",
  "customerId": "<string>",
  "name": "<string>",
  "pendingUrl": "<string>",
  "failedUrl": "<string>",
  "successUrl": "<string>",
  "referenceId": "<string>",
  "userTaxId": "<string>",
  "shipTo": {
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "postalCode": "<string>"
  },
  "sameAsBilling": true,
  "payMethod": [],
  "redirectionType": "NEW_PAGE",
  "expiryDate": "2023-11-07T05:31:56Z",
  "invoice": {
    "issueDate": "2023-12-25",
    "dueDate": "2023-12-25"
  },
  "serviceStart": "2023-12-25",
  "serviceEnd": "2023-12-25",
  "meta": {
    "param1": "<string>",
    "param2": "<string>",
    "param3": "<string>"
  },
  "referrerUrl": "<string>",
  "enableMandatoryPopup": true
}
'

import requests

url = "https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession"

payload = {
    "returnUrl": "<string>",
    "billTo": {
        "name": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
    },
    "items": [
        {
            "name": "<string>",
            "quantity": 123,
            "amount": 123,
            "attributes": [
                {
                    "orderId": "<string>",
                    "userId": "<string>",
                    "clientId": "<string>"
                }
            ],
            "productReferenceId": "<string>",
            "description": "<string>",
            "hsnCode": "<string>",
            "shippable": False
        }
    ],
    "email": "<string>",
    "clientReferenceId": "<string>",
    "phoneNo": "+91-9876543210",
    "taxIdentity": "<string>",
    "gstIdentity": "<string>",
    "customerId": "<string>",
    "name": "<string>",
    "pendingUrl": "<string>",
    "failedUrl": "<string>",
    "successUrl": "<string>",
    "referenceId": "<string>",
    "userTaxId": "<string>",
    "shipTo": {
        "name": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "postalCode": "<string>"
    },
    "sameAsBilling": True,
    "payMethod": [],
    "redirectionType": "NEW_PAGE",
    "expiryDate": "2023-11-07T05:31:56Z",
    "invoice": {
        "issueDate": "2023-12-25",
        "dueDate": "2023-12-25"
    },
    "serviceStart": "2023-12-25",
    "serviceEnd": "2023-12-25",
    "meta": {
        "param1": "<string>",
        "param2": "<string>",
        "param3": "<string>"
    },
    "referrerUrl": "<string>",
    "enableMandatoryPopup": True
}
headers = {
    "x-api-key": "<api-key>",
    "x-signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    returnUrl: '<string>',
    billTo: {
      name: '<string>',
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      postalCode: '<string>'
    },
    items: [
      {
        name: '<string>',
        quantity: 123,
        amount: 123,
        attributes: [{orderId: '<string>', userId: '<string>', clientId: '<string>'}],
        productReferenceId: '<string>',
        description: '<string>',
        hsnCode: '<string>',
        shippable: false
      }
    ],
    email: '<string>',
    clientReferenceId: '<string>',
    phoneNo: '+91-9876543210',
    taxIdentity: '<string>',
    gstIdentity: '<string>',
    customerId: '<string>',
    name: '<string>',
    pendingUrl: '<string>',
    failedUrl: '<string>',
    successUrl: '<string>',
    referenceId: '<string>',
    userTaxId: '<string>',
    shipTo: {
      name: '<string>',
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      country: '<string>',
      postalCode: '<string>'
    },
    sameAsBilling: true,
    payMethod: [],
    redirectionType: 'NEW_PAGE',
    expiryDate: '2023-11-07T05:31:56Z',
    invoice: {issueDate: '2023-12-25', dueDate: '2023-12-25'},
    serviceStart: '2023-12-25',
    serviceEnd: '2023-12-25',
    meta: {param1: '<string>', param2: '<string>', param3: '<string>'},
    referrerUrl: '<string>',
    enableMandatoryPopup: true
  })
};

fetch('https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'returnUrl' => '<string>',
    'billTo' => [
        'name' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>'
    ],
    'items' => [
        [
                'name' => '<string>',
                'quantity' => 123,
                'amount' => 123,
                'attributes' => [
                                [
                                                                'orderId' => '<string>',
                                                                'userId' => '<string>',
                                                                'clientId' => '<string>'
                                ]
                ],
                'productReferenceId' => '<string>',
                'description' => '<string>',
                'hsnCode' => '<string>',
                'shippable' => false
        ]
    ],
    'email' => '<string>',
    'clientReferenceId' => '<string>',
    'phoneNo' => '+91-9876543210',
    'taxIdentity' => '<string>',
    'gstIdentity' => '<string>',
    'customerId' => '<string>',
    'name' => '<string>',
    'pendingUrl' => '<string>',
    'failedUrl' => '<string>',
    'successUrl' => '<string>',
    'referenceId' => '<string>',
    'userTaxId' => '<string>',
    'shipTo' => [
        'name' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'country' => '<string>',
        'postalCode' => '<string>'
    ],
    'sameAsBilling' => true,
    'payMethod' => [
        
    ],
    'redirectionType' => 'NEW_PAGE',
    'expiryDate' => '2023-11-07T05:31:56Z',
    'invoice' => [
        'issueDate' => '2023-12-25',
        'dueDate' => '2023-12-25'
    ],
    'serviceStart' => '2023-12-25',
    'serviceEnd' => '2023-12-25',
    'meta' => [
        'param1' => '<string>',
        'param2' => '<string>',
        'param3' => '<string>'
    ],
    'referrerUrl' => '<string>',
    'enableMandatoryPopup' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession"

	payload := strings.NewReader("{\n  \"returnUrl\": \"<string>\",\n  \"billTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"amount\": 123,\n      \"attributes\": [\n        {\n          \"orderId\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"clientId\": \"<string>\"\n        }\n      ],\n      \"productReferenceId\": \"<string>\",\n      \"description\": \"<string>\",\n      \"hsnCode\": \"<string>\",\n      \"shippable\": false\n    }\n  ],\n  \"email\": \"<string>\",\n  \"clientReferenceId\": \"<string>\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"<string>\",\n  \"gstIdentity\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"shipTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"sameAsBilling\": true,\n  \"payMethod\": [],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"expiryDate\": \"2023-11-07T05:31:56Z\",\n  \"invoice\": {\n    \"issueDate\": \"2023-12-25\",\n    \"dueDate\": \"2023-12-25\"\n  },\n  \"serviceStart\": \"2023-12-25\",\n  \"serviceEnd\": \"2023-12-25\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"referrerUrl\": \"<string>\",\n  \"enableMandatoryPopup\": true\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"returnUrl\": \"<string>\",\n  \"billTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"amount\": 123,\n      \"attributes\": [\n        {\n          \"orderId\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"clientId\": \"<string>\"\n        }\n      ],\n      \"productReferenceId\": \"<string>\",\n      \"description\": \"<string>\",\n      \"hsnCode\": \"<string>\",\n      \"shippable\": false\n    }\n  ],\n  \"email\": \"<string>\",\n  \"clientReferenceId\": \"<string>\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"<string>\",\n  \"gstIdentity\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"shipTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"sameAsBilling\": true,\n  \"payMethod\": [],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"expiryDate\": \"2023-11-07T05:31:56Z\",\n  \"invoice\": {\n    \"issueDate\": \"2023-12-25\",\n    \"dueDate\": \"2023-12-25\"\n  },\n  \"serviceStart\": \"2023-12-25\",\n  \"serviceEnd\": \"2023-12-25\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"referrerUrl\": \"<string>\",\n  \"enableMandatoryPopup\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"returnUrl\": \"<string>\",\n  \"billTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"amount\": 123,\n      \"attributes\": [\n        {\n          \"orderId\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"clientId\": \"<string>\"\n        }\n      ],\n      \"productReferenceId\": \"<string>\",\n      \"description\": \"<string>\",\n      \"hsnCode\": \"<string>\",\n      \"shippable\": false\n    }\n  ],\n  \"email\": \"<string>\",\n  \"clientReferenceId\": \"<string>\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"<string>\",\n  \"gstIdentity\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"shipTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"sameAsBilling\": true,\n  \"payMethod\": [],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"expiryDate\": \"2023-11-07T05:31:56Z\",\n  \"invoice\": {\n    \"issueDate\": \"2023-12-25\",\n    \"dueDate\": \"2023-12-25\"\n  },\n  \"serviceStart\": \"2023-12-25\",\n  \"serviceEnd\": \"2023-12-25\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"referrerUrl\": \"<string>\",\n  \"enableMandatoryPopup\": true\n}"

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

{
  "status": "<string>",
  "sub_status": "<string>",
  "data": {
    "sessionId": "<string>",
    "url": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Merchant API Key

x-signature

string

header

required

Generated request signature

Body

application/json

quoteCurrCode

enum<string>

required

Fiat currency for which the request needs to be initiated.

Available options:

USD,

EURO,

INR

returnUrl

string

required

This URL is needed to redirect the user after the session is completed. The end customer will be redirected to this URL with the status of the session.

billTo

object

required

Billing details of the customer for the invoice.

Show child attributes

items

object[]

required

Name of the product the customer wants to buy. Allowed: alphabets, numerals, spaces, dots, slash, hyphen, parentheses, underscore, and colon.

Show child attributes

string

Customer's email. Required to send an invoice. One of email or clientReferenceId is a mandatory parameter.

clientReferenceId

string

Customer's reference ID that the partner can use to map the customer to the TransactBridge panel. If email is not passed in the request body, the customer must enter the email on the product checkout page. One of email or clientReferenceId is a mandatory parameter.

phoneNo

string

The customer's Indian phone number in the format of +91-XXXXXXXX

Example:

"+91-9876543210"

theme

enum<string>

Checkout renders accordingly to choosen theme.

Available options:

LIGHT,

DARK,

AUTO

taxIdentity

string

PAN number of the customer.

gstIdentity

string

If the customer is business type then GST can be used so that the business can get input credits.

customerId

string<MongoId>

If the customer is already created, use customerId and then email will be optional.

name

string<AllowedString>

Name of the customer.

pendingUrl

string

This URL is needed to redirect the user after the session is in CREATED or STARTED status. Mandatory if returnUrl is not passed.

failedUrl

string

URL to redirect the user when the session is in EXPIRED status. Manadtory if returnUrl is not passed

successUrl

string

URL to redirect the user when the session is in CLOSED status. Manadatory if returnUrl passed

referenceId

string<ReferenceId>

Reference ID passed by the partner while generating the session.

userTaxId

string

Tax ID created by the partner.This allows us to tax the product correctly.

shipTo

object

Shipping details of the customer.

Show child attributes

sameAsBilling

boolean

Makes the shipping address the same as the billing address. If sameAsBilling the parameter value is set as true then the invoice will have the same shipping and billing address.

payMethod

enum<string>[]

Payment methods that will be displayed to the customer. If the payMethod parameter is sent by the partner then on the payment page for the customer only that payment method will be visible to the user.

Available options:

UPI,

NB,

CC,

DC

redirectionType

enum<string>

default:NEW_PAGE

Depending on the redirection type value, the user will either be redirected to a new page for payment or to the same window of the product page.

Available options:

SAME_PAGE,

NEW_PAGE

discount

object

This parameter can be used to reduce the total cart pay amount.

Show child attributes

expiryDate

string<date-time>

The UTC date at which the session link will expire. If this is not passed by the partner, then the link will expire after 24 hours. This is the expiry of the link if a customer attempts the payment at the last minute, then the link will not expire until all the payment attempts transactions are not in the terminal state.

Note: Minimum 10 minutes in the future will be accepted as a valid expiryDate from the time of session creation.

invoice

object

Invoice configuration for the product sold in this billing session.

Show child attributes

serviceStart

string<date>

If the product is for a specific period, then the invoice created for the customer will have this parameter.

serviceEnd

string<date>

If the product is for a specific period, then the invoice created for the customer will have this parameter.

Response

200 - application/json

Payment session created successfully.

status

string

The response from the API

sub_status

string

Used for internal purposes only

data

object

Contains the session ID and URL

Show child attributes

Create Payment Session

curl --request POST \
  --url https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "returnUrl": "<string>",
  "billTo": {
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "items": [
    {
      "name": "<string>",
      "quantity": 123,
      "amount": 123,
      "attributes": [
        {
          "orderId": "<string>",
          "userId": "<string>",
          "clientId": "<string>"
        }
      ],
      "productReferenceId": "<string>",
      "description": "<string>",
      "hsnCode": "<string>",
      "shippable": false
    }
  ],
  "email": "<string>",
  "clientReferenceId": "<string>",
  "phoneNo": "+91-9876543210",
  "taxIdentity": "<string>",
  "gstIdentity": "<string>",
  "customerId": "<string>",
  "name": "<string>",
  "pendingUrl": "<string>",
  "failedUrl": "<string>",
  "successUrl": "<string>",
  "referenceId": "<string>",
  "userTaxId": "<string>",
  "shipTo": {
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "postalCode": "<string>"
  },
  "sameAsBilling": true,
  "payMethod": [],
  "redirectionType": "NEW_PAGE",
  "expiryDate": "2023-11-07T05:31:56Z",
  "invoice": {
    "issueDate": "2023-12-25",
    "dueDate": "2023-12-25"
  },
  "serviceStart": "2023-12-25",
  "serviceEnd": "2023-12-25",
  "meta": {
    "param1": "<string>",
    "param2": "<string>",
    "param3": "<string>"
  },
  "referrerUrl": "<string>",
  "enableMandatoryPopup": true
}
'

import requests

url = "https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession"

payload = {
    "returnUrl": "<string>",
    "billTo": {
        "name": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
    },
    "items": [
        {
            "name": "<string>",
            "quantity": 123,
            "amount": 123,
            "attributes": [
                {
                    "orderId": "<string>",
                    "userId": "<string>",
                    "clientId": "<string>"
                }
            ],
            "productReferenceId": "<string>",
            "description": "<string>",
            "hsnCode": "<string>",
            "shippable": False
        }
    ],
    "email": "<string>",
    "clientReferenceId": "<string>",
    "phoneNo": "+91-9876543210",
    "taxIdentity": "<string>",
    "gstIdentity": "<string>",
    "customerId": "<string>",
    "name": "<string>",
    "pendingUrl": "<string>",
    "failedUrl": "<string>",
    "successUrl": "<string>",
    "referenceId": "<string>",
    "userTaxId": "<string>",
    "shipTo": {
        "name": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "postalCode": "<string>"
    },
    "sameAsBilling": True,
    "payMethod": [],
    "redirectionType": "NEW_PAGE",
    "expiryDate": "2023-11-07T05:31:56Z",
    "invoice": {
        "issueDate": "2023-12-25",
        "dueDate": "2023-12-25"
    },
    "serviceStart": "2023-12-25",
    "serviceEnd": "2023-12-25",
    "meta": {
        "param1": "<string>",
        "param2": "<string>",
        "param3": "<string>"
    },
    "referrerUrl": "<string>",
    "enableMandatoryPopup": True
}
headers = {
    "x-api-key": "<api-key>",
    "x-signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    returnUrl: '<string>',
    billTo: {
      name: '<string>',
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      postalCode: '<string>'
    },
    items: [
      {
        name: '<string>',
        quantity: 123,
        amount: 123,
        attributes: [{orderId: '<string>', userId: '<string>', clientId: '<string>'}],
        productReferenceId: '<string>',
        description: '<string>',
        hsnCode: '<string>',
        shippable: false
      }
    ],
    email: '<string>',
    clientReferenceId: '<string>',
    phoneNo: '+91-9876543210',
    taxIdentity: '<string>',
    gstIdentity: '<string>',
    customerId: '<string>',
    name: '<string>',
    pendingUrl: '<string>',
    failedUrl: '<string>',
    successUrl: '<string>',
    referenceId: '<string>',
    userTaxId: '<string>',
    shipTo: {
      name: '<string>',
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      country: '<string>',
      postalCode: '<string>'
    },
    sameAsBilling: true,
    payMethod: [],
    redirectionType: 'NEW_PAGE',
    expiryDate: '2023-11-07T05:31:56Z',
    invoice: {issueDate: '2023-12-25', dueDate: '2023-12-25'},
    serviceStart: '2023-12-25',
    serviceEnd: '2023-12-25',
    meta: {param1: '<string>', param2: '<string>', param3: '<string>'},
    referrerUrl: '<string>',
    enableMandatoryPopup: true
  })
};

fetch('https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'returnUrl' => '<string>',
    'billTo' => [
        'name' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>'
    ],
    'items' => [
        [
                'name' => '<string>',
                'quantity' => 123,
                'amount' => 123,
                'attributes' => [
                                [
                                                                'orderId' => '<string>',
                                                                'userId' => '<string>',
                                                                'clientId' => '<string>'
                                ]
                ],
                'productReferenceId' => '<string>',
                'description' => '<string>',
                'hsnCode' => '<string>',
                'shippable' => false
        ]
    ],
    'email' => '<string>',
    'clientReferenceId' => '<string>',
    'phoneNo' => '+91-9876543210',
    'taxIdentity' => '<string>',
    'gstIdentity' => '<string>',
    'customerId' => '<string>',
    'name' => '<string>',
    'pendingUrl' => '<string>',
    'failedUrl' => '<string>',
    'successUrl' => '<string>',
    'referenceId' => '<string>',
    'userTaxId' => '<string>',
    'shipTo' => [
        'name' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'country' => '<string>',
        'postalCode' => '<string>'
    ],
    'sameAsBilling' => true,
    'payMethod' => [
        
    ],
    'redirectionType' => 'NEW_PAGE',
    'expiryDate' => '2023-11-07T05:31:56Z',
    'invoice' => [
        'issueDate' => '2023-12-25',
        'dueDate' => '2023-12-25'
    ],
    'serviceStart' => '2023-12-25',
    'serviceEnd' => '2023-12-25',
    'meta' => [
        'param1' => '<string>',
        'param2' => '<string>',
        'param3' => '<string>'
    ],
    'referrerUrl' => '<string>',
    'enableMandatoryPopup' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession"

	payload := strings.NewReader("{\n  \"returnUrl\": \"<string>\",\n  \"billTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"amount\": 123,\n      \"attributes\": [\n        {\n          \"orderId\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"clientId\": \"<string>\"\n        }\n      ],\n      \"productReferenceId\": \"<string>\",\n      \"description\": \"<string>\",\n      \"hsnCode\": \"<string>\",\n      \"shippable\": false\n    }\n  ],\n  \"email\": \"<string>\",\n  \"clientReferenceId\": \"<string>\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"<string>\",\n  \"gstIdentity\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"shipTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"sameAsBilling\": true,\n  \"payMethod\": [],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"expiryDate\": \"2023-11-07T05:31:56Z\",\n  \"invoice\": {\n    \"issueDate\": \"2023-12-25\",\n    \"dueDate\": \"2023-12-25\"\n  },\n  \"serviceStart\": \"2023-12-25\",\n  \"serviceEnd\": \"2023-12-25\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"referrerUrl\": \"<string>\",\n  \"enableMandatoryPopup\": true\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"returnUrl\": \"<string>\",\n  \"billTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"amount\": 123,\n      \"attributes\": [\n        {\n          \"orderId\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"clientId\": \"<string>\"\n        }\n      ],\n      \"productReferenceId\": \"<string>\",\n      \"description\": \"<string>\",\n      \"hsnCode\": \"<string>\",\n      \"shippable\": false\n    }\n  ],\n  \"email\": \"<string>\",\n  \"clientReferenceId\": \"<string>\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"<string>\",\n  \"gstIdentity\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"shipTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"sameAsBilling\": true,\n  \"payMethod\": [],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"expiryDate\": \"2023-11-07T05:31:56Z\",\n  \"invoice\": {\n    \"issueDate\": \"2023-12-25\",\n    \"dueDate\": \"2023-12-25\"\n  },\n  \"serviceStart\": \"2023-12-25\",\n  \"serviceEnd\": \"2023-12-25\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"referrerUrl\": \"<string>\",\n  \"enableMandatoryPopup\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.transactbridge.com/billingSession/v1.0/generateBillingSession")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"returnUrl\": \"<string>\",\n  \"billTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"name\": \"<string>\",\n      \"quantity\": 123,\n      \"amount\": 123,\n      \"attributes\": [\n        {\n          \"orderId\": \"<string>\",\n          \"userId\": \"<string>\",\n          \"clientId\": \"<string>\"\n        }\n      ],\n      \"productReferenceId\": \"<string>\",\n      \"description\": \"<string>\",\n      \"hsnCode\": \"<string>\",\n      \"shippable\": false\n    }\n  ],\n  \"email\": \"<string>\",\n  \"clientReferenceId\": \"<string>\",\n  \"phoneNo\": \"+91-9876543210\",\n  \"taxIdentity\": \"<string>\",\n  \"gstIdentity\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"userTaxId\": \"<string>\",\n  \"shipTo\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"country\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"sameAsBilling\": true,\n  \"payMethod\": [],\n  \"redirectionType\": \"NEW_PAGE\",\n  \"expiryDate\": \"2023-11-07T05:31:56Z\",\n  \"invoice\": {\n    \"issueDate\": \"2023-12-25\",\n    \"dueDate\": \"2023-12-25\"\n  },\n  \"serviceStart\": \"2023-12-25\",\n  \"serviceEnd\": \"2023-12-25\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  },\n  \"referrerUrl\": \"<string>\",\n  \"enableMandatoryPopup\": true\n}"

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

{
  "status": "<string>",
  "sub_status": "<string>",
  "data": {
    "sessionId": "<string>",
    "url": "<string>"
  }
}

API Documentation

Session

Subscription

Mandate

Invoices

Transactions

Settlements

Customers

Products

Distribution

PACB

Others

Create Payment Session

How it works

Transaction details

Authorizations

Body

Response