Skip to content
straddle API Docs
  • Auto
  • Light
  • Dark
Get started
API Reference
Embed
Accounts
View as Markdown
Copy Markdown
Open in Claude
Open in ChatGPT

Capability Requests

Request a capability
embed.accounts.capability_requests.create(straccount_id, CapabilityRequestCreateParams**kwargs) -> CapabilityRequestPagedV1
post/v1/accounts/{account_id}/capability_requests
List capability requests
embed.accounts.capability_requests.list(straccount_id, CapabilityRequestListParams**kwargs) -> SyncPageNumberSchema[Data]
get/v1/accounts/{account_id}/capability_requests
ModelsExpand Collapse
class CapabilityRequestPagedV1: …
data: List[Data]
id: str

Unique identifier for the capability request.

formatuuid
account_id: str

The unique identifier of the account associated with this capability request.

formatuuid
category: Literal["payment_type", "customer_type", "consent_type"]

The category of the requested capability. Use payment_type for charges and payouts, customer_type to define individuals or businesses, and consent_type for signed_agreement or internet payment authorization.

Accepts one of the following:
"payment_type"
"customer_type"
"consent_type"
created_at: datetime

Timestamp of when the capability request was created.

formatdate-time
status: Literal["active", "inactive", "in_review", 3 more]

The current status of the capability request.

Accepts one of the following:
"active"
"inactive"
"in_review"
"rejected"
"approved"
"reviewing"
type: Literal["charges", "payouts", "individuals", 3 more]

The specific type of capability being requested within the category.

Accepts one of the following:
"charges"
"payouts"
"individuals"
"businesses"
"signed_agreement"
"internet"
updated_at: datetime

Timestamp of the most recent update to the capability request.

formatdate-time
settings: Optional[Dict[str, object]]

Any specific settings or configurations related to the requested capability.

Metadata about the API request, including an identifier, timestamp, and pagination details.

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
max_page_size: int

Maximum allowed page size for this endpoint.

formatint32
page_number: int

Page number for paginated results.

formatint32
page_size: int

Number of items per page in this response.

formatint32
sort_by: str

The field that the results were sorted by.

sort_order: Literal["asc", "desc"]
Accepts one of the following:
"asc"
"desc"
total_items: int

Total number of items returned in this response.

formatint32
total_pages: int

The number of pages available.

formatint32
response_type: Literal["object", "array", "error", "none"]

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.
Accepts one of the following:
"object"
"array"
"error"
"none"