Hyperwallet Payout API

Name: Hyperwallet Payout API API
Brand: Hyperwallet Payout API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayouts Transfersbasic13 EndpointsREST

For Agents

Onboard payees, send payouts, configure bank accounts and transfer methods, and subscribe to webhooks through Hyperwallet from an AI agent or backend service.

Quickstart

Get started with Hyperwallet Payout API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"send a payout to a creator"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Hyperwallet Payout API API.

Create and update payee user records inside a Hyperwallet program

Issue a payment to a payee with currency, amount, and purpose fields

Add and update bank account transfer methods for a payee

List and configure transfer methods available to a payee

Subscribe to webhook notifications for payment lifecycle events

GET STARTED

Start building with Hyperwallet Payout API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Hyperwallet Payout API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Hyperwallet Payout API, keeping it validated and agent-ready. Hyperwallet is a PayPal-owned payout platform; the API exposes 13 endpoints for managing payee users, issuing payments, configuring bank accounts and transfer methods, and subscribing to webhook notifications. Calls run against the v4 sandbox at https://api.sandbox.hyperwallet.com/rest/v4 and authenticate with HTTP basic credentials issued from the Hyperwallet program portal. The API is designed for marketplaces, gig platforms, and creator economies that need to send money to many recipients.

Use Cases

Patterns agents use Hyperwallet Payout API API for, with concrete tasks.

★ Marketplace Seller Payouts

Run weekly payouts to marketplace sellers or freelancers by creating a user via /users, attaching a bank account via /users/{userToken}/bank-accounts, and issuing a payment via /payments. The webhook-notifications resource lets the marketplace track payout status without polling. This automates a flow that would otherwise require manual ACH or wire transfers.

POST /users to create the payee, POST /users/{userToken}/bank-accounts to attach a bank account, then POST /payments for $200 USD.

Bank Account Onboarding

Build a payee onboarding flow that captures bank routing details and stores them on Hyperwallet through /users/{userToken}/bank-accounts. The API validates bank routing numbers and returns a transfer method token that future payouts reference, so the marketplace never stores raw bank credentials directly.

POST /users/{userToken}/bank-accounts with the routing number, account number, and currency.

Payout Status Webhooks

Wire Hyperwallet webhook-notifications into an internal status dashboard or finance pipeline so finished payouts close out invoices automatically. The webhook payload includes the payment token, status, and timestamp, which downstream systems can match against a payout register. Saves polling /payments/{paymentToken} on a timer.

POST /webhook-notifications with the program webhook URL and an event filter for payment status changes.

AI Agent Payout Operations

Give a finance ops AI assistant a scoped 'send_payout' tool that calls Hyperwallet via Jentic. The agent searches for 'send a payout to a creator', loads the schema, and executes the POST /payments call — the basic-auth credentials never enter the agent context, which matters for sensitive money-movement operations.

Search Jentic for 'send a payout', load the Hyperwallet POST /payments schema, and execute with currency=USD and amount=200.

Key Endpoints

13 endpoints — jentic publishes the only available openapi specification for hyperwallet payout api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/users

Create a payee user

GET

/users/{userToken}

Retrieve a payee user record

POST

/payments

Issue a payment to a payee

GET

/payments/{paymentToken}

Retrieve a payment by token

POST

/users/{userToken}/bank-accounts

Add a bank account to a payee

GET

/users/{userToken}/transfer-methods

List transfer methods for a payee

POST

/webhook-notifications

Subscribe to webhook notifications

POST

/users

Create a payee user

GET

/users/{userToken}

Retrieve a payee user record

POST

/payments

Issue a payment to a payee

GET

/payments/{paymentToken}

Retrieve a payment by token

POST

/users/{userToken}/bank-accounts

Add a bank account to a payee

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Hyperwallet basic credentials are stored encrypted in the Jentic vault. Agents receive a scoped reference and Jentic injects the Authorization header at execution time, so the raw username and password never enter the agent's context or logs.

Intent-based discovery

Agents search Jentic by intent (e.g., 'send a payout to a creator') and Jentic returns the matching Hyperwallet operation with its input schema, so the agent does not need to map a payout flow across users, transfer methods, and payments by hand.

Time to first call

Direct Hyperwallet integration: 2-3 days to wire up payee onboarding, transfer-method validation, and webhook signing. Through Jentic: under 2 hours.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

PayPal Payouts API

PayPal Payouts is the parent-platform alternative with similar bulk-payout endpoints

Choose PayPal Payouts when already on the PayPal stack with simple needs; choose Hyperwallet for marketplace-style payee onboarding and transfer-method management

Alternative

Payoneer API

Payoneer is a marketplace payout alternative with similar bulk-payout endpoints

Choose Payoneer for international freelancer payouts with local receiving accounts; choose Hyperwallet when already on the PayPal stack

Complementary

Stripe API

Stripe collects payments from buyers while Hyperwallet sends payouts to sellers — they pair in marketplaces

Use Stripe to charge buyers and Hyperwallet to pay sellers in a two-sided marketplace

FAQs

Specific to using Hyperwallet Payout API API through Jentic.

Why is there no official OpenAPI spec for Hyperwallet Payout API?

Hyperwallet publishes developer documentation but not a canonical OpenAPI specification in the catalogue. Jentic generates and maintains this spec so AI agents and developers can call Hyperwallet via structured tooling. It is validated against the documented API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Hyperwallet Payout API use?

The Hyperwallet API uses HTTP basic authentication with credentials issued from the Hyperwallet program portal. Through Jentic the basic credentials are stored in the credential vault and Jentic injects the Authorization header at execution time, so the raw credentials never enter the agent's context.

Can I send a payout through the Hyperwallet API?

Yes. POST /payments with the destination user token, currency, amount, and purpose to issue a payout, then poll /payments/{paymentToken} or subscribe to /webhook-notifications to track status. Bank account transfer methods must be configured on the payee user before payouts can settle.

What are the rate limits for the Hyperwallet Payout API?

The OpenAPI spec does not declare numeric rate limits. Hyperwallet sets program-specific limits in the merchant portal, so check your program configuration and watch for HTTP 429 responses to back off automatically before scaling traffic.

How do I onboard a new payee through Jentic?

Search Jentic for 'create a Hyperwallet payee', load the schema for POST /users, and execute with the payee profile fields. Install with pip install jentic and use the async search, load, and execute pattern, then attach a bank account via POST /users/{userToken}/bank-accounts.

Does the Hyperwallet API support webhook notifications?

Yes. POST /webhook-notifications subscribes the program to lifecycle events, and incoming payloads include the payment token and status. This avoids polling /payments/{paymentToken} on a timer to track payout completion.