The Query Drivers Cash Block Actions API enables Fleet suppliers to retrieve the current cash block status for their fleet drivers within the Uber system. This API allows suppliers to query the active cash block or unblock actions for one or more fleet drivers, providing visibility into which drivers are currently blocked from receiving cash trips and when those blocks or unblocks expire.

¶ Use case

In a Fleet suppliers platform, the Query Drivers Cash Block Actions API provides critical visibility into driver cash dispatch states. For instance, Fleet companies can integrate this API into their driver profile pages to show drivers their current cash block status in real-time. This enables better communication with drivers about their ability to receive cash trips and helps debug issues where cash block functionality may not be working as expected. Additionally, suppliers can use this API to verify that cash block actions have been successfully applied after making changes through the Cash Block Action API.

¶ Support for Hierarchical Data

The Query Drivers Cash Block Actions API automatically operates within the hierarchical structure of the organization linked to the developer’s account at the time of setup.

¶ Supported supplier types

Fleets

¶ Scopes

vehicle_suppliers.cash_block.read

¶ Resource

/v1/vehicle-suppliers/query-cash-block-actions

¶ HTTP Method

POST

¶ Authorization

Authorization Code

¶ Example Request

curl -X POST "https://api.uber.com/v1/vehicle-suppliers/query-cash-block-actions" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "supplier_uuid": {
        "value": "<encrypted partner_uuid>"
    },
    "earner_uuids": [
        {
            "value":"<encrypted driver_uuid>"
        },
        {
            "value": "<encrypted driver_uuid>"
        }
    ]
  }'

Request Body parameters

Name	Type	Description	Required
supplier_uuid	UUID	UUID of the vehicle supplier organization	Yes
earner_uuids	Array	List of encrypted driver UUIDs to query status for	Yes

¶ Example Response

Status-code: 200 OK
{
    "cash_block_overrides": [
      {
         "supplier_uuid": {
          "value":"<encrypted partner_uuid>"
        },
        "earner_uuid": {
          "value":"<encrypted partner_uuid>"
        },
        "effective_at": "2025-10-23T10:13:06Z",
        "expires_at": "2025-10-25T10:13:06Z",
        "override_activity": "OVERRIDE_ACTIVITY_UNBLOCK",
        "block_type": "BLOCK_TYPE_API"
      },
      {
         "supplier_uuid": {
          "value":"<encrypted partner_uuid>"
        },
        "earner_uuid": {
          "value":"<encrypted partner_uuid>"
        },
        "expires_at": "2025-10-27T10:13:06Z",
        "override_activity": "OVERRIDE_ACTIVITY_BLOCK",
        "block_type": "BLOCK_TYPE_API"
      }
    ]
}

¶ Response Body Parameters

Name	Type	Description
cash_block_overrides	Array	List of active cash block overrides for the requested fleet drivers

¶ Response Fields - Cash Block Override

Name	Type	Description
supplier_uuid	UUID	Encrypted UUID of the vehicle supplier organization
earner_uuid	UUID	Encrypted UUID of the fleet driver (earner)
effective_at	String	ISO 8601 timestamp in UTC when the “cash unblock” action became effective (only present for unblock actions)
expires_at	String	ISO 8601 timestamp in UTC when the cash block or unblock override expires
override_activity	String	The override activity applied: OVERRIDE_ACTIVITY_BLOCK or OVERRIDE_ACTIVITY_UNBLOCK
block_type	String	Type of block applied: BLOCK_TYPE_API, BLOCK_TYPE_ADHOC, BLOCK_TYPE_CONFIG, or BLOCK_TYPE_MISSING

¶ Block Types

Block Type	Description
BLOCK_TYPE_API	Block or unblock applied via API
BLOCK_TYPE_ADHOC	Manual block or unblock applied via Supplier Portal
BLOCK_TYPE_CONFIG	Automatic block applied based on system configuration
BLOCK_TYPE_MISSING	Block type information is not available

¶ Rate limit

The rate limit for this endpoint is 2000 requests per hour (RPH).

¶ Endpoint Specific Errors

Http Status Code	Code	Message
400	bad_request	Invalid request parameters
401	unauthorized	The requesting user is not authorized to perform the action.
404	not_found	Supplier or fleet driver not found
429	rate_limited	Number of requests exceeded allowed limit
500	internal_server_error	Internal server error occurred
503	service_unavailable	Service is currently unavailable

¶ Notes

Important considerations for querying cash block status

• This API retrieves only active cash block actions. Expired overrides will not be returned in the response.

• Multiple fleet drivers can be queried in a single API call for efficient batch operations.

• The response will include both block (OVERRIDE_ACTIVITY_BLOCK) and unblock (OVERRIDE_ACTIVITY_UNBLOCK) overrides that are currently active.

• The block_type field indicates the source of the override, allowing you to distinguish between API-driven blocks, manual blocks from the Supplier Portal, and automatic system-configured blocks.

• Use this API to verify that cash block actions applied via the Cash Block Action API have been successfully processed.

• If a driver UUID is provided in the request but has no active cash block override, that driver will not appear in the response array.