Policies
Get the policy a capability's requests must declare right now
Returns the policy bound to a capability and the version a request for it must declare right now.
GET
/
policies
/
in-effect
Get the policy a capability's requests must declare right now
curl --request GET \
--url https://parmana-api-real.vercel.app/policies/in-effect \
--header 'Authorization: Bearer <token>'import requests
url = "https://parmana-api-real.vercel.app/policies/in-effect"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://parmana-api-real.vercel.app/policies/in-effect', 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://parmana-api-real.vercel.app/policies/in-effect",
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: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://parmana-api-real.vercel.app/policies/in-effect"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://parmana-api-real.vercel.app/policies/in-effect")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://parmana-api-real.vercel.app/policies/in-effect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"capability": "paytm:refund",
"policy": {
"name": "customer-refund",
"version": "1.1.0",
"schemaVersion": "1.0.0"
}
}{
"error": "businessTransactionId must be a valid UUID."
}{
"error": "authentication required"
}{
"error": "businessTransactionId must be a valid UUID."
}{
"error": "businessTransactionId must be a valid UUID."
}{
"error": "businessTransactionId must be a valid UUID."
}{
"error": "businessTransactionId must be a valid UUID."
}Authorizations
Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer . Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.
Query Parameters
The capability, the Intent action, for example paytm:refund.
⌘I
Get the policy a capability's requests must declare right now
curl --request GET \
--url https://parmana-api-real.vercel.app/policies/in-effect \
--header 'Authorization: Bearer <token>'import requests
url = "https://parmana-api-real.vercel.app/policies/in-effect"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://parmana-api-real.vercel.app/policies/in-effect', 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://parmana-api-real.vercel.app/policies/in-effect",
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: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://parmana-api-real.vercel.app/policies/in-effect"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://parmana-api-real.vercel.app/policies/in-effect")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://parmana-api-real.vercel.app/policies/in-effect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"capability": "paytm:refund",
"policy": {
"name": "customer-refund",
"version": "1.1.0",
"schemaVersion": "1.0.0"
}
}{
"error": "businessTransactionId must be a valid UUID."
}{
"error": "authentication required"
}{
"error": "businessTransactionId must be a valid UUID."
}{
"error": "businessTransactionId must be a valid UUID."
}{
"error": "businessTransactionId must be a valid UUID."
}{
"error": "businessTransactionId must be a valid UUID."
}