PACB

Create Payment Request

This API is used to create a unique payment request with a specific amount directly to the end customer without Transact Bridge’s Checkout page. Once the user pays the requested amount through the selected payment channel, the partner gets a webhook call for a successful credit of the same deposit. The partner then needs to send the required verification details for the payment using the Upload Verification Details API.

Payment status and transaction verification status can be found using the Get Transaction API.

Note: This API endpoint is not available to all partners. Reach out Tech support team to enable this configuration.

POST

payment

v1.0

createPaymentRequest

Create Payment Request

curl --request POST \
  --url https://sandbox-api.transactbridge.com/payment/v1.0/createPaymentRequest \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "quoteAmount": "<string>",
  "quoteCurrCode": "<string>",
  "referenceId": "<string>",
  "email": "<string>",
  "phoneNo": "<string>",
  "name": "<string>",
  "returnUrl": "<string>",
  "meta": {
    "param1": "<string>",
    "param2": "<string>",
    "param3": "<string>"
  }
}
'

import requests

url = "https://sandbox-api.transactbridge.com/payment/v1.0/createPaymentRequest"

payload = {
    "quoteAmount": "<string>",
    "quoteCurrCode": "<string>",
    "referenceId": "<string>",
    "email": "<string>",
    "phoneNo": "<string>",
    "name": "<string>",
    "returnUrl": "<string>",
    "meta": {
        "param1": "<string>",
        "param2": "<string>",
        "param3": "<string>"
    }
}
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({
    quoteAmount: '<string>',
    quoteCurrCode: '<string>',
    referenceId: '<string>',
    email: '<string>',
    phoneNo: '<string>',
    name: '<string>',
    returnUrl: '<string>',
    meta: {param1: '<string>', param2: '<string>', param3: '<string>'}
  })
};

fetch('https://sandbox-api.transactbridge.com/payment/v1.0/createPaymentRequest', 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/payment/v1.0/createPaymentRequest",
  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([
    'quoteAmount' => '<string>',
    'quoteCurrCode' => '<string>',
    'referenceId' => '<string>',
    'email' => '<string>',
    'phoneNo' => '<string>',
    'name' => '<string>',
    'returnUrl' => '<string>',
    'meta' => [
        'param1' => '<string>',
        'param2' => '<string>',
        'param3' => '<string>'
    ]
  ]),
  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/payment/v1.0/createPaymentRequest"

	payload := strings.NewReader("{\n  \"quoteAmount\": \"<string>\",\n  \"quoteCurrCode\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  }\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/payment/v1.0/createPaymentRequest")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quoteAmount\": \"<string>\",\n  \"quoteCurrCode\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"quoteAmount\": \"<string>\",\n  \"quoteCurrCode\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  }\n}"

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

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

Authorizations

x-api-key

string

header

required

Merchant API Key

x-signature

string

header

required

Generated request signature

Body

application/json

quoteAmount

string

required

Amount that needs to be collected from end user

quoteCurrCode

string

required

Base currency of the quoteAmount

referenceId

string<ReferenceId>

required

This is a partner ID to map a billing session with their generated ID. This cannot be the same for two sessions.

payMethod

enum<string>

required

The payMethod that is to be used to collect the payment from the end customer.

For different payMethod there are different params to send the correspoding values mandatory for that payMethod.As of now only UPI is supported.

Available options:

UPI,

CC,

DC,

NB

string

Customer's email. Require this to send an invoice.

phoneNo

string

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

name

string<AllowedString>

Name of the customer

returnUrl

string<uri>

If the payMethod is CC, DC, NB Then this parameter is Mandatory 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.

Response

200 - application/json

createPaymentRequest

status

string

The response from the API

sub_status

string

Used for internal purposes only

data

object

Contains the sessionId and URL.

Create Payment Request

curl --request POST \
  --url https://sandbox-api.transactbridge.com/payment/v1.0/createPaymentRequest \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "quoteAmount": "<string>",
  "quoteCurrCode": "<string>",
  "referenceId": "<string>",
  "email": "<string>",
  "phoneNo": "<string>",
  "name": "<string>",
  "returnUrl": "<string>",
  "meta": {
    "param1": "<string>",
    "param2": "<string>",
    "param3": "<string>"
  }
}
'

import requests

url = "https://sandbox-api.transactbridge.com/payment/v1.0/createPaymentRequest"

payload = {
    "quoteAmount": "<string>",
    "quoteCurrCode": "<string>",
    "referenceId": "<string>",
    "email": "<string>",
    "phoneNo": "<string>",
    "name": "<string>",
    "returnUrl": "<string>",
    "meta": {
        "param1": "<string>",
        "param2": "<string>",
        "param3": "<string>"
    }
}
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({
    quoteAmount: '<string>',
    quoteCurrCode: '<string>',
    referenceId: '<string>',
    email: '<string>',
    phoneNo: '<string>',
    name: '<string>',
    returnUrl: '<string>',
    meta: {param1: '<string>', param2: '<string>', param3: '<string>'}
  })
};

fetch('https://sandbox-api.transactbridge.com/payment/v1.0/createPaymentRequest', 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/payment/v1.0/createPaymentRequest",
  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([
    'quoteAmount' => '<string>',
    'quoteCurrCode' => '<string>',
    'referenceId' => '<string>',
    'email' => '<string>',
    'phoneNo' => '<string>',
    'name' => '<string>',
    'returnUrl' => '<string>',
    'meta' => [
        'param1' => '<string>',
        'param2' => '<string>',
        'param3' => '<string>'
    ]
  ]),
  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/payment/v1.0/createPaymentRequest"

	payload := strings.NewReader("{\n  \"quoteAmount\": \"<string>\",\n  \"quoteCurrCode\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  }\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/payment/v1.0/createPaymentRequest")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quoteAmount\": \"<string>\",\n  \"quoteCurrCode\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"quoteAmount\": \"<string>\",\n  \"quoteCurrCode\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNo\": \"<string>\",\n  \"name\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"meta\": {\n    \"param1\": \"<string>\",\n    \"param2\": \"<string>\",\n    \"param3\": \"<string>\"\n  }\n}"

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

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

API Documentation

Session

Subscription

Mandate

Invoices

Transactions

Settlements

Customers

Products

Distribution

PACB

Others

Create Payment Request

Authorizations

Body

Response