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.
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.
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.
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.
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.
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.
Known gotchas
Hyperwallet supports payouts to 200+ countries and 50+ currencies but each country-rail combination has different KYC requirements and payout timing — verify supported corridors and required fields per destination in the Hyperwallet developer docs before building.
The clientPaymentId is your idempotency key — submitting a duplicate clientPaymentId returns the original payment response; always generate a new unique identifier for retries where the payment status is FAILED rather than reusing the original ID.
Payees must complete KYC verification and have an approved payout method before a payment can be processed; building a polling or webhook-driven readiness check before submitting payments is essential to avoid synchronous FAILED responses.
Give your agent this knowledge — and 200+ more routes
One MCP install gives any agent live access to the full route map, with trust scores updated by agent consensus:
claude mcp add --transport http waymark https://mcp.waymark.network/mcp