CapabilityRequests

List capability requests

Changed on

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

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/accounts/{account_id}/capability_requests
  • Auth
    HTTP bearer

Path parameters

account_idstring uuid required

Query parameters

type'charges' | 'payouts' | 'individuals' | 'businesses' | 'signed_agreement' | 'internet'

Filter capability requests by the specific type of capability.

category'payment_type' | 'customer_type' | 'consent_type'

Filter capability requests by category.

status'active' | 'inactive' | 'in_review' | 'rejected'

Filter capability requests by their current status.

page_numberinteger

Results page number. Starts at page 1.

page_sizeinteger

Page size. Max value: 1000

Page size.Max value: 1000

sort_bystring

Sort By. Default value: 'id'.

Sort By.

sort_order'asc' | 'desc'

Sort Order. Default value: 'asc'.

Sort Order.

Headers

request-idstring

Optional client generated identifier to trace and debug a request.

correlation-idstring

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

Response

OK

response_type'object' | 'array' | 'error' | 'none' 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.

Changes

  • 456c9ef0c3a6Revision changes
    • info

      added the required property // to the response with the status (media type: text/plain)

    • info

      added the required property // to the response with the status (media type: application/json)

    • info

      added the required property // to the response with the status (media type: text/json)

  • 197302a1e983Revision changes
    • breaking

      removed the required property // from the response with the status (media type: text/plain)

    • breaking

      removed the required property // from the response with the status (media type: application/json)

    • breaking

      removed the required property // from the response with the status (media type: text/json)