Send global mass payouts to sellers and contractors via PayPal Enterprise Payouts (Hyperwallet)

Steps

1. Apply for access to PayPal Enterprise Payouts (formerly Hyperwallet) through PayPal's enterprise sales channel — it is not self-serve; once provisioned, receive program credentials and API documentation from your implementation manager.
2. Authenticate with Hyperwallet's REST API using HTTP Basic Authentication with your program credentials; all requests go to the program-specific base URL provided during onboarding.
3. Create a payee (user) record via POST /v4/users with required fields including client_user_id, program_token, profile_type (INDIVIDUAL or BUSINESS), and address fields; Hyperwallet performs KYC verification asynchronously.
4. Once the user is ACTIVATED, create a payout method (bank account, PayPal, prepaid card, etc.) via POST /v4/users/{userToken}/bankAccounts or the appropriate endpoint for the chosen payout rail in the target country.
5. Initiate a payment via POST /v4/payments with amount, currency, purpose, destination_token (the user's payout method token), and a unique clientPaymentId for idempotency.
6. Subscribe to webhook events (USER_ACCOUNT_STATUS_TRANSITION, PAYMENT_STATUS_TRANSITION) to track KYC completions and payment outcomes; check payment.status transitions through SCHEDULED, IN_PROGRESS, COMPLETED, or FAILED.