curl --request POST \
--url https://{tenantDomain}.conductor.one/api/v1/funds/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"grant": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>"
}
'import requests
url = "https://{tenantDomain}.conductor.one/api/v1/funds/rules"
payload = {
"displayName": "<string>",
"grant": {
"amount": { "money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
} },
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
grant: {
amount: {money: {currencyCode: '<string>', nanos: 123, units: '<string>'}},
blocked: {},
unlimited: {}
},
groupRef: {appId: '<string>', id: '<string>'},
reason: '<string>'
})
};
fetch('https://{tenantDomain}.conductor.one/api/v1/funds/rules', 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://{tenantDomain}.conductor.one/api/v1/funds/rules",
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([
'displayName' => '<string>',
'grant' => [
'amount' => [
'money' => [
'currencyCode' => '<string>',
'nanos' => 123,
'units' => '<string>'
]
],
'blocked' => [
],
'unlimited' => [
]
],
'groupRef' => [
'appId' => '<string>',
'id' => '<string>'
],
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{tenantDomain}.conductor.one/api/v1/funds/rules"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenantDomain}.conductor.one/api/v1/funds/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}.conductor.one/api/v1/funds/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"rule": {
"createdAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"grant": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>",
"ruleId": "<string>",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Create
Create funds a group. The group is an AppEntitlement, so membership resolves through that entitlement’s bindings on every acquire rather than being captured here. Creating the tenant’s first rule is what turns group resolution on for that tenant.
curl --request POST \
--url https://{tenantDomain}.conductor.one/api/v1/funds/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"grant": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>"
}
'import requests
url = "https://{tenantDomain}.conductor.one/api/v1/funds/rules"
payload = {
"displayName": "<string>",
"grant": {
"amount": { "money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
} },
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
displayName: '<string>',
grant: {
amount: {money: {currencyCode: '<string>', nanos: 123, units: '<string>'}},
blocked: {},
unlimited: {}
},
groupRef: {appId: '<string>', id: '<string>'},
reason: '<string>'
})
};
fetch('https://{tenantDomain}.conductor.one/api/v1/funds/rules', 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://{tenantDomain}.conductor.one/api/v1/funds/rules",
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([
'displayName' => '<string>',
'grant' => [
'amount' => [
'money' => [
'currencyCode' => '<string>',
'nanos' => 123,
'units' => '<string>'
]
],
'blocked' => [
],
'unlimited' => [
]
],
'groupRef' => [
'appId' => '<string>',
'id' => '<string>'
],
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{tenantDomain}.conductor.one/api/v1/funds/rules"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenantDomain}.conductor.one/api/v1/funds/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}.conductor.one/api/v1/funds/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"rule": {
"createdAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"grant": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>",
"ruleId": "<string>",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.
Body
The FundRuleServiceCreateRequest message.
The displayName field.
SpendLimit is the three-way behavior fork. Which arms are legal depends on the scope carrying it; pkg/funds enforces that matrix, not the schema, because one SpendControls shape is shared by every scope.
This message contains a oneof named kind. Only a single field of the following list may be set at a time:
- unlimited
- amount
- blocked
Show child attributes
Show child attributes
The AppEntitlementRef message.
Show child attributes
Show child attributes
The reason field.
Response
Successful response
The FundRuleServiceCreateResponse message.
FundRule is one group grant as the API renders it.
Show child attributes
Show child attributes
Was this page helpful?