Payout accounts

Retrieve payout account

Changed on

Retrieves the details of an existing payout account.

Required permissions:

  • payout:account:read
get/payout_accounts/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/payout_accounts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:poact_xxxxxxxxxxxx

The unique identifier of the payout account to retrieve.

Response

A successful response

business_namestring nullable required

The company's legal name

emailstring nullable required

The email address of the representative

idstring required

The unique identifier for the payout account.

phonestring nullable required

The business representative's phone

status'connected' | 'disabled' | 'action_required' | 'pending_verification' | 'verification_failed' | 'manual_review' | 'denied' | 'not_started' | 'blocked_by_parent' required

The granular calculated statuses reflecting payout account KYC and payout readiness.

Example response

{
  "id": "poact_xxxxxxxxxxxx",
  "latest_verification": {
    "id": "verf_xxxxxxxxxxxxx",
    "last_error_reason": "Document image was too blurry to read."
  }
}

Changes

  • 099fdc3be422Revision changes
    • warning

      added the new blocked_by_parent enum value to the //// response property for the response status

    • warning

      added the new denied enum value to the //// response property for the response status

    • warning

      added the new manual_review enum value to the / response property for the response status

    • warning

      added the new manual_review enum value to the //// response property for the response status