STstellar
Distribution Wallets

Get Account Capabilities

Changed on

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.

get/distribution-wallets/{id}/capabilities

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Path parameters

idstring required

The unique identifier of the distribution account

Query parameters

user_idstring

Report this user's capabilities instead of the caller's. Owner only.

role'financial_controller' | 'developer' | 'business' | 'initiator' | 'approver'

Report the capabilities a user would have if granted this role. Owner only.

Response

Capabilities retrieved successfully

wallet_idstring
user_idstring

Present when the capabilities of another user were requested

rolestring

Present when the capabilities of a hypothetical role were requested

capabilitiesobject

Example response

{
  "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
  }
}

Changes