Get Account Capabilities
Reports what the caller may do on one distribution account, combining their tenant-wide role with the role they hold on that account.
Owners can also ask what a third party could do, by passing user_id. Add role alongside it to ask hypothetically what that user could do if granted that role. role cannot be sent on its own and returns 400 without user_id. This backs the dashboard’s access-granting picker, which warns when a grant would be inert because the user’s tenant-wide role already excludes the action.
curl --request GET \
--url https://api.example.com/distribution-wallets/{id}/capabilities \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/distribution-wallets/{id}/capabilities"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/distribution-wallets/{id}/capabilities', 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://api.example.com/distribution-wallets/{id}/capabilities",
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: <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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/distribution-wallets/{id}/capabilities"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/distribution-wallets/{id}/capabilities")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/distribution-wallets/{id}/capabilities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"wallet_id": "8d1f6a2e-3c4b-4a5d-9e6f-7a8b9c0d1e2f",
"capabilities": {
"can_create_disbursement": true,
"can_start_disbursement": false,
"can_pause_disbursement": false,
"can_cancel_disbursement": false,
"can_create_payment": true,
"can_retry_payment": true,
"can_cancel_payment": false
}
}{
"error": "<string>",
"extras": {}
}{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}{
"error": "Forbidden"
}{
"error": "Not found",
"extras": {
"status": 404,
"message": "Resource not found"
}
}Authorizations
Authorization header containing an SDP JWT (ES256) or an SDP_ API key.
Path Parameters
The unique identifier of the distribution account
Query Parameters
Report this user's capabilities instead of the caller's. Owner only.
Report the capabilities a user would have if granted this role. Owner only.
financial_controller, developer, business, initiator, approver Response
Capabilities retrieved successfully
What the subject may actually do on one account, combining their tenant-wide role with the role they hold on that account. Both gates apply, so this is reported as a capability set rather than a single effective role.
curl --request GET \
--url https://api.example.com/distribution-wallets/{id}/capabilities \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/distribution-wallets/{id}/capabilities"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/distribution-wallets/{id}/capabilities', 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://api.example.com/distribution-wallets/{id}/capabilities",
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: <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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/distribution-wallets/{id}/capabilities"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/distribution-wallets/{id}/capabilities")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/distribution-wallets/{id}/capabilities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"wallet_id": "8d1f6a2e-3c4b-4a5d-9e6f-7a8b9c0d1e2f",
"capabilities": {
"can_create_disbursement": true,
"can_start_disbursement": false,
"can_pause_disbursement": false,
"can_cancel_disbursement": false,
"can_create_payment": true,
"can_retry_payment": true,
"can_cancel_payment": false
}
}{
"error": "<string>",
"extras": {}
}{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}{
"error": "Forbidden"
}{
"error": "Not found",
"extras": {
"status": 404,
"message": "Resource not found"
}
}