What you can do
- Create and onboard recipients
- Send payouts individually or in batches
- Track payment status from creation to settlement
- Collect and retrieve recipient tax forms (W-9)
- Record payments made outside of Karat for reporting
- Subscribe to webhooks for asynchronous updates
How it works
Generate an API key
Create an API key from your Karat dashboard and store it securely. See
Authentication.
Add recipients
Create recipients with
POST /recipients.
Each recipient receives an onboarding link to complete their profile.Send payouts
Send one or more payouts with
POST /payments,
using an idempotencyKey so retries are safe.Listen for updates
Subscribe a callback URL to events like
payout.updated to receive
status changes as they happen. See Webhooks.Explore the API
Authentication
Generate, use, and rotate your API keys.
Environments
Base URL and how to get sandbox access.
Payments
Create, list, retrieve, and cancel payouts.
Recipients
Add and manage the payees you send to.
Webhooks
Subscribe to asynchronous event notifications.
Sandbox testing
Simulate payout outcomes before going live.
All amounts in the Payout API are integers in the smallest currency unit
(cents). For example,
$250.00 is 25000.