import Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
const payoutAccount = await client.payoutAccounts.retrieve('poact_xxxxxxxxxxxx');
console.log(payoutAccount.id);{
"id": "poact_xxxxxxxxxxxx",
"status": "connected",
"business_name": "<string>",
"phone": "<string>",
"email": "<string>",
"business_representative": {
"date_of_birth": "<string>",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>"
},
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>",
"country": "<string>"
},
"latest_verification": {
"id": "verf_xxxxxxxxxxxxx",
"status": "requires_input",
"last_error_code": "abandoned",
"last_error_reason": "Document image was too blurry to read."
}
}Retrieves the details of an existing payout account.
Required permissions:
payout:account:readimport Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
const payoutAccount = await client.payoutAccounts.retrieve('poact_xxxxxxxxxxxx');
console.log(payoutAccount.id);{
"id": "poact_xxxxxxxxxxxx",
"status": "connected",
"business_name": "<string>",
"phone": "<string>",
"email": "<string>",
"business_representative": {
"date_of_birth": "<string>",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>"
},
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>",
"country": "<string>"
},
"latest_verification": {
"id": "verf_xxxxxxxxxxxxx",
"status": "requires_input",
"last_error_code": "abandoned",
"last_error_reason": "Document image was too blurry to read."
}
}A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
The unique identifier of the payout account to retrieve.
"poact_xxxxxxxxxxxx"
A successful response
An object representing an account used for payouts.
The unique identifier for the payout account.
"poact_xxxxxxxxxxxx"
The granular calculated status of the payout account reflecting its current KYC and withdrawal readiness state.
connected, disabled, action_required, pending_verification, verification_failed, not_started The company's legal name
The business representative's phone
The email address of the representative
The business representative for this payout account
Show child attributes
The physical address associated with this payout account
Show child attributes
The latest verification for the connected account.
Show child attributes
Was this page helpful?