The Capability object

Attributes

id string The identifier for the capability.
account string Expandable The account for which the capability enables functionality.
requested boolean Whether the capability has been requested.
requirements object Information about the requirements for the capability, including what information needs to be collected, and by when.
status enum The status of the capability. Possible enum values active The capability is active. inactive The capability is inactive. pending The capability is inactive with requirements pending verification. unrequested The capability is unrequested.

More attributes

object string, value is "capability"
future _ requirements object
requested _ at nullable timestamp

{ "id": "card_payments", "object": "capability", "account": "acct_1032D82eZvKYlo2C", "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "requested": true, "requested_at": 1688491010, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "status": "inactive"}

Update an Account Capability

POST / v1 / accounts /:id / capabilities /:id

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

Parameters

requested boolean To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the requirements arrays. If a capability isn’t permanent, you can remove it from the account by passing false. Some capabilities are permanent after they’ve been requested. Attempting to remove a permanent capability returns an error.

More parameters

preview boolean Preview feature

Returns

Returns an Account Capability object.

Response

{ "id": "card_payments", "object": "capability", "account": "acct_1032D82eZvKYlo2C", "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "requested": true, "requested_at": 1688491010, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "status": "inactive"}

Retrieve an Account Capability

GET / v1 / accounts /:id / capabilities /:id

Retrieves information about the specified Account Capability.

Parameters

No parameters.

Returns

Returns an Account Capability object.

Response

{ "id": "card_payments", "object": "capability", "account": "acct_1032D82eZvKYlo2C", "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "requested": true, "requested_at": 1688491010, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "status": "inactive"}