List accounts

Returns a list of accounts associated with your Straddle platform integration. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. This endpoint supports advanced sorting and filtering options.

GET /v1/accounts

cURL

cURL

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

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",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "business",
      "status": "created",
      "status_detail": {
        "reason": "unverified",
        "source": "watchtower",
        "code": "<string>",
        "message": "<string>"
      },
      "access_level": "standard",
      "business_profile": {
        "name": "<string>",
        "website": "<string>",
        "legal_name": "<string>",
        "description": "<string>",
        "use_case": "<string>",
        "tax_id": "<string>",
        "phone": "<string>",
        "address": {
          "line1": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "line2": "<string>",
          "country": "<string>"
        },
        "industry": {
          "mcc": "<string>",
          "sector": "<string>",
          "category": "<string>"
        },
        "support_channels": {
          "email": "[e-mail]",
          "phone": "<string>",
          "url": "<string>"
        }
      },
      "capabilities": {
        "payment_types": {
          "charges": {
            "capability_status": "active"
          },
          "payouts": {
            "capability_status": "active"
          }
        },
        "customer_types": {
          "individuals": {
            "capability_status": "active"
          },
          "businesses": {
            "capability_status": "active"
          }
        },
        "consent_types": {
          "signed_agreement": {
            "capability_status": "active"
          },
          "internet": {
            "capability_status": "active"
          }
        }
      },
      "settings": {
        "charges": {
          "max_amount": 123,
          "monthly_amount": 123,
          "daily_amount": 123,
          "monthly_count": 123,
          "funding_time": "immediate",
          "linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "payouts": {
          "max_amount": 123,
          "monthly_amount": 123,
          "daily_amount": 123,
          "monthly_count": 123,
          "funding_time": "immediate",
          "linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "terms_of_service": {
        "accepted_date": "2023-11-07T05:31:56Z",
        "agreement_url": "<string>",
        "agreement_type": "embedded",
        "accepted_ip": "<string>",
        "accepted_user_agent": "<string>"
      },
      "metadata": {},
      "external_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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.

Query Parameters

page_number · integer<int32> · default: 1

Results page number. Starts at page 1. Default value: 1

page_size · integer<int32> · default: 100

Page size. Default value: 100. Max value: 1000

sort_by · string · default: id

Sort By. Default value: 'id'.

sort_order · enum<string> · default: asc

Sort Order. Default value: 'asc'.

Available options: asc, desc

search_text · string

status · enum<string>

Available options: created, onboarding, active, rejected, inactive

type · enum<string>

Available options: business

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