Skip to content
Get started

Capability Requests

Capabilities enable specific features and services for an Account. Use capability requests to unlock higher processing limits, new payment types, or additional platform features as your users' businesses grow. Track approval status and manage documentation requirements through a single interface.

Request a capability
$ straddle embed:accounts:capability-requests create
POST/v1/accounts/{account_id}/capability_requests
List capability requests
$ straddle embed:accounts:capability-requests list
GET/v1/accounts/{account_id}/capability_requests
ModelsExpand Collapse
capabilityRequestPagedV1: object { data, meta, response_type }
data: array of object { id, account_id, category, 6 more }
id: string

Unique identifier for the capability request.

account_id: string

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

category: "payment_type" or "customer_type" or "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.

"payment_type"
"customer_type"
"consent_type"
created_at: string

Timestamp of when the capability request was created.

enable: boolean

Whether this capability request is to enable or disable the capability.

status: "active" or "inactive" or "in_review" or 3 more

The current status of the capability request.

"active"
"inactive"
"in_review"
"rejected"
"approved"
"reviewing"
type: "charges" or "payouts" or "individuals" or 3 more

The specific type of capability being requested within the category.

"charges"
"payouts"
"individuals"
"businesses"
"signed_agreement"
"internet"
updated_at: string

Timestamp of the most recent update to the capability request.

settings: optional map[unknown]

Any specific settings or configurations related to the requested capability.

meta: object { api_request_id, api_request_timestamp, max_page_size, 6 more }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

max_page_size: number

Maximum allowed page size for this endpoint.

page_number: number

Page number for paginated results.

page_size: number

Number of items per page in this response.

sort_by: string

The field that the results were sorted by.

sort_order: "asc" or "desc"
"asc"
"desc"
total_items: number

Total number of items returned in this response.

total_pages: number

The number of pages available.

response_type: "object" or "array" or "error" or "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.
"object"
"array"
"error"
"none"