Capabilities
Capabilities determine the possible actions an account is allowed to take. Accounts are granted capabilities based on the type of account and verification completed.
An account's capabilities can be revoked due to payment failures. See payment errors and capabilities.
Accounts with the closed, processing, or disabled status will not have any
capabilities. See account statuses to learn more.
caution
Since an account is owned by an entity, capabilities of that entity take precedence over an account's capabilities.
Example: Accounts, with the payments:send capability owned by an entity without the payments:send
capability are not allowed to send payments.
Capability prefixesâ
| Prefix | Example | Description |
|---|---|---|
payments | payments:send | This prefix indicates that a capability is part of Method Payments. |
data | data:retrieve | This prefix indicates that a capability is part of Method Data. |
âšī¸ See account capabilities for details on the API.
Receive paymentsâ
An account is allowed to receive funds if it has the payments:receive capability
activated. Both ACH and liability accounts can activate this capability.
Send paymentsâ
An account is allowed to send funds if it has the payments:send capability
activated. Only ACH accounts can activate this capability. For some teams, ACH accounts
are required to be verified in order to activate this capability.
âĄī¸ See the ACH Verification section to learn more.
Retrieve dataâ
An account is allowed to retrieve comprehensive liability data if
it has the data:retrieve capability activated. Only accounts created through
the identity verification flow can activate this capability.
Sync dataâ
An account is allowed to sync / refresh a liability's data if it has the data:sync capability activated.