---
updatedAt: 2026-06-30T16:05:21.000Z
agentTools:
  projectIndex: https://docs.pelcro.com/llms.txt
---

# Revoke vendor payout detail

Revoke authorization for a vendor's payout detail.

## Overview

Revoke authorization for a vendor's payout detail. Once revoked, the vendor can no longer receive payouts until re-authorized.

**Example:** Temporarily suspend payouts to a vendor pending a bank account verification.

***

## Important Behaviors

* **Sets authorization\_status to 'revoked'**.
* **Idempotent**: Revoking an already-revoked payout detail is a no-op (status stays 'revoked').
* **Audit logged**: The revocation is recorded in the audit log.
* **Webhook**: Triggers the `vendor_payout_detail.revoked` webhook event.
* **Payout readiness**: `is_payout_ready` becomes `false` after revocation.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "core-api",
    "version": "1.88"
  },
  "servers": [
    {
      "url": "https://www.pelcro.com/api/v1/core"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      },
      "sec1": {
        "type": "apiKey",
        "in": "query",
        "name": "site_id"
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": []
    }
  ],
  "paths": {
    "/vendors/payout-details/{id}/revoke": {
      "post": {
        "description": "Revoke authorization for a vendor's payout detail.",
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"data\": {\n    \"id\": 1,\n    \"vendor_id\": 50,\n    \"account_id\": 100,\n    \"account_holder_name\": \"Jane Smith\",\n    \"bank_name\": \"Chase\",\n    \"routing_number\": \"****0021\",\n    \"account_number\": \"****7890\",\n    \"account_type\": \"checking\",\n    \"currency\": \"usd\",\n    \"country\": \"US\",\n    \"payout_method_status\": \"enabled\",\n    \"vendor_internal_identifier\": \"V0000000050\",\n    \"transaction_type\": \"credit\",\n    \"authorization_status\": \"revoked\",\n    \"authorization_timestamp\": 1650974100,\n    \"authorization_method\": \"electronic\",\n    \"authorized_by\": 42,\n    \"is_payout_ready\": false,\n    \"created_at\": 1650974042,\n    \"updated_at\": 1650974042\n  },\n  \"status\": \"success\"\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request, please try again.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "error": {
                        "status": 400,
                        "message": "Invalid request, please try again."
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthenticated.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "error": "Unauthenticated."
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "error": {
                        "status": 404,
                        "message": "Not found."
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The payout detail ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "site_id",
            "in": "query",
            "description": "The unique identifier of the site associated with your account.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Bearer eyJ***"
            }
          }
        ],
        "operationId": "post_vendors-payout-details-id-revoke",
        "summary": "Revoke vendor payout detail"
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```