Permissions

The permissions available depend on the person’s role on the account. Users with Owner or Admin roles have full access to all Direct Debit operations. Users with balance-level roles can only access Direct Debits within their assigned balances. When using a person-level API key, the following permissions are required:

API permissions

Permission	Description
`budgets-direct-debits:read:any`	Read any Direct Debit on the account
`budgets-direct-debits:read:own`	Read Direct Debits on budgets you have access to
`budgets-direct-debits:create:any`	Create Direct Debits on any budget
`budgets-direct-debits:update:any`	Update (cancel) Direct Debits on any budget

API endpoints summary

Endpoint	Method	Description
`/v2/direct-debits`	GET	List all Direct Debits
`/v2/budgets/{budgetId}/direct-debits/{directDebitId}`	GET	Get a specific Direct Debit
`/v2/budgets/{budgetId}/direct-debits`	POST	Create a Direct Debit
`/v2/budgets/{budgetId}/direct-debits/{directDebitId}/cancel`	POST	Cancel a Direct Debit
`/v2/budgets/{budgetId}/direct-debits/{directDebitId}/payment-requests`	GET	List payment requests

Group placeholder

Group

Group

API permissions

API endpoints summary

​API permissions

​API endpoints summary

API permissions

API endpoints summary