Create
curl --request POST \
--url https://{tenantDomain}.conductor.one/api/v1/funds/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"currencyCode": "<string>",
"defaultLimit": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
}
}
'import requests
url = "https://{tenantDomain}.conductor.one/api/v1/funds/policy"
payload = {
"currencyCode": "<string>",
"defaultLimit": {
"amount": { "money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
} },
"blocked": {},
"unlimited": {}
}
}
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({
currencyCode: '<string>',
defaultLimit: {
amount: {money: {currencyCode: '<string>', nanos: 123, units: '<string>'}},
blocked: {},
unlimited: {}
}
})
};
fetch('https://{tenantDomain}.conductor.one/api/v1/funds/policy', 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/policy",
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([
'currencyCode' => '<string>',
'defaultLimit' => [
'amount' => [
'money' => [
'currencyCode' => '<string>',
'nanos' => 123,
'units' => '<string>'
]
],
'blocked' => [
],
'unlimited' => [
]
]
]),
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/policy"
payload := strings.NewReader("{\n \"currencyCode\": \"<string>\",\n \"defaultLimit\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n }\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/policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"currencyCode\": \"<string>\",\n \"defaultLimit\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}.conductor.one/api/v1/funds/policy")
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 \"currencyCode\": \"<string>\",\n \"defaultLimit\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"policy": {
"createdAt": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"defaultLimit": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"orgCeiling": {
"extension": {
"expiresAt": "2023-11-07T05:31:56Z",
"limit": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"reason": "<string>"
},
"limit": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"period": "PERIOD_KIND_UNSPECIFIED",
"suspension": {
"reason": "<string>",
"suspendedAt": "2023-11-07T05:31:56Z"
}
},
"period": "PERIOD_KIND_UNSPECIFIED",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Fund Policy
Create
Create the tenant’s fund policy, opting the tenant in to spend governance. default_limit is required: a tenant states its posture explicitly, and there is no implicit default anywhere in the write path.
POST
/
api
/
v1
/
funds
/
policy
Create
curl --request POST \
--url https://{tenantDomain}.conductor.one/api/v1/funds/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"currencyCode": "<string>",
"defaultLimit": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
}
}
'import requests
url = "https://{tenantDomain}.conductor.one/api/v1/funds/policy"
payload = {
"currencyCode": "<string>",
"defaultLimit": {
"amount": { "money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
} },
"blocked": {},
"unlimited": {}
}
}
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({
currencyCode: '<string>',
defaultLimit: {
amount: {money: {currencyCode: '<string>', nanos: 123, units: '<string>'}},
blocked: {},
unlimited: {}
}
})
};
fetch('https://{tenantDomain}.conductor.one/api/v1/funds/policy', 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/policy",
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([
'currencyCode' => '<string>',
'defaultLimit' => [
'amount' => [
'money' => [
'currencyCode' => '<string>',
'nanos' => 123,
'units' => '<string>'
]
],
'blocked' => [
],
'unlimited' => [
]
]
]),
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/policy"
payload := strings.NewReader("{\n \"currencyCode\": \"<string>\",\n \"defaultLimit\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n }\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/policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"currencyCode\": \"<string>\",\n \"defaultLimit\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}.conductor.one/api/v1/funds/policy")
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 \"currencyCode\": \"<string>\",\n \"defaultLimit\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"policy": {
"createdAt": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"defaultLimit": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"orgCeiling": {
"extension": {
"expiresAt": "2023-11-07T05:31:56Z",
"limit": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"reason": "<string>"
},
"limit": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"period": "PERIOD_KIND_UNSPECIFIED",
"suspension": {
"reason": "<string>",
"suspendedAt": "2023-11-07T05:31:56Z"
}
},
"period": "PERIOD_KIND_UNSPECIFIED",
"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
application/json
The FundPolicyServiceCreateRequest message.
ISO 4217. Immutable once set.
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 period field.
Available options:
PERIOD_KIND_UNSPECIFIED, PERIOD_KIND_DAILY, PERIOD_KIND_WEEKLY, PERIOD_KIND_MONTHLY, PERIOD_KIND_QUARTERLY, PERIOD_KIND_YEARLY Response
200 - application/json
Successful response
The FundPolicyServiceCreateResponse message.
FundPolicy is the tenant's fund policy as the API renders it. Every field is server-owned on the way out; requests name the fields they change rather than sending this message back.
Show child attributes
Show child attributes
Was this page helpful?