List 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.

GET /v1/accounts/{account_id}/capability_requests

cURL

cURL

curl --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/accounts/<uuid>/capability_requests

200

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z",
    "total_items": 123,
    "page_number": 123,
    "page_size": 123,
    "max_page_size": 123,
    "sort_by": "<string>",
    "sort_order": "asc",
    "total_pages": 123
  },
  "response_type": "object",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "charges",
      "category": "payment_type",
      "status": "active",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "enable": true,
      "settings": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.

Headers

request-id · string

Optional client generated identifier to trace and debug a request.

correlation-id · string

Optional client generated identifier to trace and debug a series of requests.

Path Parameters

account_id · string<uuid> · required

Query Parameters

type · enum<string>

Filter capability requests by the specific type of capability.

Available options: charges, payouts, individuals, businesses, signed_agreement, internet

category · enum<string>

Filter capability requests by category.

Available options: payment_type, customer_type, consent_type

status · enum<string>

Filter capability requests by their current status.

Available options: active, inactive, in_review, rejected

page_number · integer<int32> · default: 1

Results page number. Starts at page 1.

page_size · integer<int32> · default: 100

Page size.Max value: 1000 Page size. Max value: 1000

sort_by · string · default: id

Sort By. Sort By. Default value: 'id'.

sort_order · enum<string> · default: asc

Sort Order. Sort Order. Default value: 'asc'.

Available options: asc, desc

Response

200

text/plain

OK

meta · object · required

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

Show child attributes

response_type · enum<string> · required

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.

Available options: object, array, error, none

data · object[] · required

Show child attributes