# Capability Requests ## Request a capability `$ straddle embed:accounts:capability-requests create` **post** `/v1/accounts/{account_id}/capability_requests` Submits a request to enable a specific capability for an account. Use this endpoint to request additional features or services for an account. ### Parameters - `--account-id: string` Path param - `--businesses: optional object { enable }` Body param: Allows the account to accept payments from businesses. - `--charges: optional object { daily_amount, enable, max_amount, 2 more }` Body param: The charges capability settings for the account. - `--individuals: optional object { enable }` Body param: Allows the account to accept payments from individuals. - `--internet: optional object { enable }` Body param: Allows the account to accept payments authorized via the internet or mobile applications. - `--payouts: optional object { daily_amount, enable, max_amount, 2 more }` Body param: The payouts capability settings for the account. - `--signed-agreement: optional object { enable }` Body param: Allows the account to accept payments authorized by signed agreements or contracts. - `--correlation-id: optional string` Header param: Optional client generated identifier to trace and debug a series of requests. - `--idempotency-key: optional string` Header param: Optional client generated value to use for idempotent requests. - `--request-id: optional string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `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"` ### Example ```cli straddle embed:accounts:capability-requests create \ --api-key 'My API Key' \ --account-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "category": "payment_type", "created_at": "2019-12-27T18:11:19.117Z", "enable": true, "status": "active", "type": "charges", "updated_at": "2019-12-27T18:11:19.117Z", "settings": { "foo": "bar" } } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ``` ## List capability requests `$ straddle embed:accounts:capability-requests list` **get** `/v1/accounts/{account_id}/capability_requests` Retrieves a list of capability requests associated with an account. The requests are returned sorted by creation date, with the most recent requests appearing first. This endpoint supports advanced sorting and filtering options. ### Parameters - `--account-id: string` Path param - `--category: optional "payment_type" or "customer_type" or "consent_type"` Query param: Filter capability requests by category. - `--page-number: optional number` Query param: Results page number. Starts at page 1. - `--page-size: optional number` Query param: Page size.Max value: 1000 - `--sort-by: optional string` Query param: Sort By. - `--sort-order: optional "asc" or "desc"` Query param: Sort Order. - `--status: optional "active" or "inactive" or "in_review" or "rejected"` Query param: Filter capability requests by their current status. - `--type: optional "charges" or "payouts" or "individuals" or 3 more` Query param: Filter capability requests by the specific type of capability. - `--correlation-id: optional string` Header param: Optional client generated identifier to trace and debug a series of requests. - `--request-id: optional string` Header param: Optional client generated identifier to trace and debug a request. ### Returns - `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"` ### Example ```cli straddle embed:accounts:capability-requests list \ --api-key 'My API Key' \ --account-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e ``` #### Response ```json { "data": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "account_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "category": "payment_type", "created_at": "2019-12-27T18:11:19.117Z", "enable": true, "status": "active", "type": "charges", "updated_at": "2019-12-27T18:11:19.117Z", "settings": { "foo": "bar" } } ], "meta": { "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "api_request_timestamp": "2019-12-27T18:11:19.117Z", "max_page_size": 0, "page_number": 0, "page_size": 0, "sort_by": "sort_by", "sort_order": "asc", "total_items": 0, "total_pages": 0 }, "response_type": "object" } ``` ## Domain Types ### Capability Request Paged V1 - `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"`