Actions81
- Users Actions
- Organizations Actions
- Representatives Actions
- Bridge Actions
- Platforms Actions
- Tools Actions
- User Invites Actions
- Customers Actions
- Paykeys Actions
- Reports Actions
- Charge Actions
- Funding Events Actions
- Payments Actions
- Payout Actions
- Accounts Actions
- Get Account By Id
- put__v1_accounts_account_id
- Create Account
- get__v1_accounts
- post__v1_accounts_account_id_onboard
- post__v1_accounts_account_id_simulate
- patch__v1_internal_accounts_account_id
- get__v1_internal_accounts_account_id
- patch__v1_internal_accounts_account_id_status
- get__v1_internal_accounts_account_id_settings
- Capability Requests Actions
- Linked Bank Accounts Actions
Overview
This node operation retrieves capability requests associated with a specific account. It allows filtering these requests by type, category, and status, as well as supports pagination and sorting. This is useful for scenarios where you need to monitor or audit the capabilities requested or enabled on an account, such as checking which payment types or customer types have been requested or approved.
Practical examples include:
- Fetching all active payout capability requests for an account.
- Listing capability requests filtered by consent type that are currently under review.
- Retrieving a paginated list of capability requests sorted by their ID in ascending or descending order.
Properties
| Name | Meaning |
|---|---|
| Account Id | The unique identifier of the account for which to retrieve capability requests. Required. |
| Type | Filter capability requests by the specific type of capability. Possible values: charges, payouts, individuals, businesses, signed_agreement, internet. |
| Category | Filter capability requests by category. Possible values: payment_type, customer_type, consent_type. |
| Status | Filter capability requests by their current status. Possible values: approved, rejected, reviewing. |
| Page Number | Results page number for pagination. Starts at 1. Default is 1. Required. |
| Page Size | Number of results per page. Default is 100, maximum allowed is 1000. Required. |
| Sort By | Field to sort the results by. Default is id. Required. |
| Sort Order | Order of sorting. Possible values: asc (ascending), desc (descending). Default is asc. Required. |
| Request Id | Optional client-generated identifier to trace and debug a single request. Sent as a header. |
| Correlation Id | Optional client-generated identifier to trace and debug a series of related requests. Sent as a header. |
Output
The output JSON contains the retrieved capability requests matching the specified filters and pagination. Each item typically includes details about the capability request such as its type, category, status, and other metadata relevant to the capability request.
If binary data were involved, it would be summarized here; however, this operation deals with JSON data only.
Dependencies
- Requires an API key credential for authentication to the Straddle API.
- The base URL for API requests is dynamically set based on the configured environment credential.
- No additional external dependencies beyond standard HTTP request handling.
Troubleshooting
Common issues:
- Missing or invalid Account Id will cause the request to fail.
- Providing invalid filter values (e.g., unsupported type or status) may result in empty responses or errors from the API.
- Pagination parameters out of range (e.g., page number less than 1 or page size exceeding 1000) might cause errors or unexpected results.
- Incorrect or missing API credentials will lead to authentication failures.
Error messages:
- Authentication errors indicate problems with the API key or environment configuration.
- Validation errors usually point to incorrect input property values.
- Rate limiting or server errors should be retried after some time or checked against API usage limits.
Links and References
- Straddle API Documentation (hypothetical link)
- Refer to your API provider's documentation for detailed descriptions of capability request types, categories, and statuses.