Invoices
Refund Invoice
This API can be used to raise a refund against a particular invoice. Webhook events will be pushed for any refund status updates. The response of this API is the Refund Transaction created against the invoice. Once the Refund transaction is marked successful, a credit note will be issued. The Get Transaction API can also be used to check the refund transaction status.
Note: In the Sandbox Environment, the refund will be auto-processed 10 seconds after the request is initiated.
POST
/
invoice
/
v1.0
/
createRefund
Refund Invoice
curl --request POST \
--url https://sandbox-api.transactbridge.com/invoice/v1.0/createRefund \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-signature: <api-key>' \
--data '
{
"invoiceId": "<string>",
"comment": [
{}
],
"referenceId": "<string>",
"mode": "<string>",
"meta": {
"param1": "<string>",
"param2": "<string>",
"param3": "<string>"
}
}
'import requests
url = "https://sandbox-api.transactbridge.com/invoice/v1.0/createRefund"
payload = {
"invoiceId": "<string>",
"comment": [{}],
"referenceId": "<string>",
"mode": "<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({
invoiceId: '<string>',
comment: [{}],
referenceId: '<string>',
mode: '<string>',
meta: {param1: '<string>', param2: '<string>', param3: '<string>'}
})
};
fetch('https://sandbox-api.transactbridge.com/invoice/v1.0/createRefund', 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/invoice/v1.0/createRefund",
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([
'invoiceId' => '<string>',
'comment' => [
[
]
],
'referenceId' => '<string>',
'mode' => '<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/invoice/v1.0/createRefund"
payload := strings.NewReader("{\n \"invoiceId\": \"<string>\",\n \"comment\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"mode\": \"<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/invoice/v1.0/createRefund")
.header("x-api-key", "<api-key>")
.header("x-signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invoiceId\": \"<string>\",\n \"comment\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"mode\": \"<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/invoice/v1.0/createRefund")
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 \"invoiceId\": \"<string>\",\n \"comment\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"mode\": \"<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
Merchant API Key
Generated request signature
Body
application/json
Was this page helpful?
⌘I
Refund Invoice
curl --request POST \
--url https://sandbox-api.transactbridge.com/invoice/v1.0/createRefund \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-signature: <api-key>' \
--data '
{
"invoiceId": "<string>",
"comment": [
{}
],
"referenceId": "<string>",
"mode": "<string>",
"meta": {
"param1": "<string>",
"param2": "<string>",
"param3": "<string>"
}
}
'import requests
url = "https://sandbox-api.transactbridge.com/invoice/v1.0/createRefund"
payload = {
"invoiceId": "<string>",
"comment": [{}],
"referenceId": "<string>",
"mode": "<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({
invoiceId: '<string>',
comment: [{}],
referenceId: '<string>',
mode: '<string>',
meta: {param1: '<string>', param2: '<string>', param3: '<string>'}
})
};
fetch('https://sandbox-api.transactbridge.com/invoice/v1.0/createRefund', 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/invoice/v1.0/createRefund",
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([
'invoiceId' => '<string>',
'comment' => [
[
]
],
'referenceId' => '<string>',
'mode' => '<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/invoice/v1.0/createRefund"
payload := strings.NewReader("{\n \"invoiceId\": \"<string>\",\n \"comment\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"mode\": \"<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/invoice/v1.0/createRefund")
.header("x-api-key", "<api-key>")
.header("x-signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invoiceId\": \"<string>\",\n \"comment\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"mode\": \"<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/invoice/v1.0/createRefund")
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 \"invoiceId\": \"<string>\",\n \"comment\": [\n {}\n ],\n \"referenceId\": \"<string>\",\n \"mode\": \"<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": {}
}