Skip to main content
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

PermissionDescription
budgets-direct-debits:read:anyRead any Direct Debit on the account
budgets-direct-debits:read:ownRead Direct Debits on budgets you have access to
budgets-direct-debits:create:anyCreate Direct Debits on any budget
budgets-direct-debits:update:anyUpdate (cancel) Direct Debits on any budget

​
API endpoints summary

EndpointMethodDescription
/v2/direct-debitsGETList all Direct Debits
/v2/budgets/{budgetId}/direct-debits/{directDebitId}GETGet a specific Direct Debit
/v2/budgets/{budgetId}/direct-debitsPOSTCreate a Direct Debit
/v2/budgets/{budgetId}/direct-debits/{directDebitId}/cancelPOSTCancel a Direct Debit
/v2/budgets/{budgetId}/direct-debits/{directDebitId}/payment-requestsGETList payment requests