Uber Developers

[API] POST Cash Block Action

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

The Cash Block Action API enables Fleet suppliers to control the dispatch of cash trips to fleet drivers within the Uber system. This API allows suppliers to enable or disable cash trip assignments for individual fleet drivers, providing granular control over driver cash arrears management and reducing financial risk.

¶ Use case

In a Fleet suppliers platform, the Cash Block Action API plays a critical role in managing fleet driver’s cash trip dispatches. For instance, Fleet companies can prevent fleet drivers with outstanding cash arrears from receiving cash trips by using this API to disable cash dispatch. Once the fleet driver settles their balance, the supplier can re-enable cash trip dispatch, ensuring better cash flow management and reducing financial risk.

¶ Support for Hierarchical Data

The Cash Block Action 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.write

¶ Resource

/v1/vehicle-suppliers/cash-block-action

¶ HTTP Method

POST

¶ Authorization

Authorization Code

¶ Example Request

curl -X POST "https://api.uber.com/v1/vehicle-suppliers/cash-block-action" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "supplier_uuid": {
      "value":"<encrypted partner_uuid>"
    },
    "earner_cash_block_actions": [
      {
        "earner_uuid": {
          "value":"<encypted driver_uuid>"
        },
        "action": "CASH_BLOCK_ACTION_ENABLE"
      },
      {
        "earner_uuid": {
          "value":"<encypted driver_uuid>"
        },
        "action": "CASH_BLOCK_ACTION_DISABLE"
      }
    ],
    "effective_at": "2025-10-24T12:00:00Z"
  }'

Request Body parameters

Name	Type	Description	Required
`supplier_uuid`	UUID	UUID of the vehicle supplier organization	Yes
`earner_cash_block_actions`	Array	List of cash block actions to apply to specific fleet drivers	Yes
`effective_at`	String	ISO 8601 timestamp in UTC, reflecting when “Cash Unblock” action was effective. It is not applicable for “Cash Block” action	No

¶ Request Fields - Earner Cash Block Actions

Name	Type	Description
`earner_uuid`	UUID	Encrypted UUID of the fleet driver (earner) to apply the action to
`action`	String	Action to perform like cash block or unblock

¶ Cash Block Actions

Action	Description
`CASH_BLOCK_ACTION_ENABLE`	Enables block on cash trips to the fleet driver
`CASH_BLOCK_ACTION_DISABLE`	Disables block of cash trips to the fleet driver

¶ Example Response

Status-code: 200 OK
{
    "cash_block_overrides": [
      {
        "supplier_uuid": {
          "value":"<encrypted partner_uuid>"
        },
        "earner_uuid": {
          "value":"<encrypted partner_uuid>"
        },
        "expires_at": "2025-10-26T12:00:00Z",
        "override_activity": "OVERRIDE_ACTIVITY_BLOCK",
        "block_type": "BLOCK_TYPE_API"
      },
      {
       "supplier_uuid": {
          "value":"<encrypted partner_uuid>"
        },
        "earner_uuid": {
          "value":"<encrypted partner_uuid>"
        },
        "effective_at": "2025-10-22T12:00:00Z",
        "override_activity": "OVERRIDE_ACTIVITY_UNBLOCK",
        "expires_at": "2025-10-24T12:00:00Z",
        "block_type": "BLOCK_TYPE_API"
      }
    ]
}

¶ Response Body Parameters

Name	Type	Description
`cash_block_overrides`	Array	List of cash block actions that were applied to fleet drivers in request

¶ 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” action 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`

¶ 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 cash block management

Suppliers can CASH_BLOCK_ACTION_DISABLE cash dispatch for fleet drivers with outstanding cash arrears to prevent further cash-based trips until balances are settled.
Use the CASH_BLOCK_ACTION_ENABLE action only after verifying that the fleet driver has cleared any outstanding payments and is in good standing.
Cash unblock can be applied with an effective_at timestamp to schedule the action for a future time.
Multiple fleet drivers can be processed in a single API call for batch operations.