Paycose Docs
Tax Codes
GET/routes/options

List · Options

Retrieve pagination/filter/search/sort capabilities for THIS list route.

Pinned to ?path=/api/v1/app1/platform/wallet/tax_codes (the exact route path), so it stays correct even for nested or multi-route resources. Response is the bare route_option object: filterable fields with types/operators, enum values inline (options.source=static) or the API to populate a dropdown (options.source=api with api_path), searchable fields, sortable fields, and pagination modes. Swap path for resource to fetch a resource's primary route instead. No match returns 404 (E2001).

Generated by scripts/postman_add_route_options.py [route-options].

Request

Example

curl -X GET 'https://api.paycose.com/api/v1/app1/platform/wallet/routes/options' \
  -H 'X-Session-Token: {{session_token}}' \
  -H 'X-Test-Mode: {{x_test_mode}}'

Headers

NameValueDescription
X-Session-Token{{session_token}}
X-Test-Mode{{x_test_mode}}true=wallet_test, false=wallet_live (default). Toggle the x_test_mode collection variable to flip every applicable request.

Responses

00

Headers

NameValue
Content-Typeapplication/json

Body

{
  "location": "<string>",
  "object": "<string>",
  "message": "<string>",
  "code": 0,
  "key": "<string>",
  "i18n_key": "<string>",
  "provider": "<string>",
  "provider_code": "<string>",
  "param": "<string>",
  "request_id": "<string>",
  "reason": "<string>"
}
200200 OK

Headers

NameValue
Content-Typeapplication/json

Body

{
  "object": "<string>",
  "path": "<string>",
  "method": "<string>",
  "resource": "<string>",
  "grammar": "<string>",
  "modes": [
    "<string>"
  ],
  "sort": {
    "param": "<string>",
    "fields": [
      "<string>"
    ],
    "default": "<string>"
  },
  "search": {
    "enabled": false,
    "param": "<string>",
    "fields": [
      "<string>"
    ]
  },
  "filters": [
    {
      "field": "<string>",
      "type": "<FieldType>",
      "operators": [
        "<string>"
      ],
      "options": {
        "source": "<string>",
        "values": [
          "<string>"
        ],
        "api_path": "<string>",
        "api_method": "<string>",
        "value_field": "<string>",
        "label_field": "<string>"
      }
    }
  ]
}

On this page