Invoices
Approve Draft Invoice
This API works for subscription-based invoices only. For subscriptions, on the day of subscription renewal, DRAFT invoice is created which needs the approval of the partner to make it available to the customer. Partner will get a webhook event when a new DRAFT invoice is ready for a customer. Partner needs to mark the invoice APPROVED within 24 hours or else it will be auto-marked APPROVED by the system.
POST
/
invoice
/
v1.0
/
approveInvoice
Approve Draft Invoice
curl --request POST \
--url https://sandbox-api.transactbridge.com/invoice/v1.0/approveInvoice \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-signature: <api-key>' \
--data '
{
"invoiceId": "<string>"
}
'import requests
url = "https://sandbox-api.transactbridge.com/invoice/v1.0/approveInvoice"
payload = { "invoiceId": "<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>'})
};
fetch('https://sandbox-api.transactbridge.com/invoice/v1.0/approveInvoice', 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/approveInvoice",
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>'
]),
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/approveInvoice"
payload := strings.NewReader("{\n \"invoiceId\": \"<string>\"\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/approveInvoice")
.header("x-api-key", "<api-key>")
.header("x-signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invoiceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.transactbridge.com/invoice/v1.0/approveInvoice")
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}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"sub_status": "<string>",
"data": {}
}Authorizations
Merchant API Key
Generated request signature
Body
application/json
The ID of the invoice to approve
Was this page helpful?
⌘I
Approve Draft Invoice
curl --request POST \
--url https://sandbox-api.transactbridge.com/invoice/v1.0/approveInvoice \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-signature: <api-key>' \
--data '
{
"invoiceId": "<string>"
}
'import requests
url = "https://sandbox-api.transactbridge.com/invoice/v1.0/approveInvoice"
payload = { "invoiceId": "<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>'})
};
fetch('https://sandbox-api.transactbridge.com/invoice/v1.0/approveInvoice', 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/approveInvoice",
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>'
]),
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/approveInvoice"
payload := strings.NewReader("{\n \"invoiceId\": \"<string>\"\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/approveInvoice")
.header("x-api-key", "<api-key>")
.header("x-signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invoiceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.transactbridge.com/invoice/v1.0/approveInvoice")
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}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"sub_status": "<string>",
"data": {}
}