Revoke payout detail

Revoke authorization for a vendor's payout detail.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.
Path Params
int32
required

The payout detail ID.

Query Params
int32
required

The unique identifier of the site associated with your account.

Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json