Authorize payout detail

Authorize a vendor's payout detail for payment processing.

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

Overview

Authorize a vendor's payout detail for payment processing. Once authorized (and payout method is enabled), the vendor is ready to receive payouts.

Example: Approve a vendor's bank account details after verifying them.


Important Behaviors

  • Sets authorization_status to 'authorized' and records the timestamp and who authorized it.
  • Idempotent: Authorizing an already-authorized payout detail overwrites the timestamp and authorized_by.
  • Audit logged: The authorization is recorded in the audit log.
  • Webhook: Triggers the vendor_payout_detail.authorized webhook event.
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