Skip to main content
Gruv.ai logo
Developer resources

Test the payload. Replay the webhook. Ship the first workflow.

Build POST requests, simulate payout.completed and payout.failed events, map close fields, and hand finance the export spec they need. All before the first production call.

API payload builderWebhook simulatorClose-field exportsIntegration patterns
docs.gruv.apppayoutscreate-payout
Search docs⌘K
POST/v1/payouts

Create a payout. Returns a payout object once routing and approvals clear.

Run in sandbox
POST /v1/payouts
Authorization: Bearer sk_live_••••
{
"amount": 14200,
"currency": "USD",
"payee": "py_29ax8c2v",
"rail": "ach_same_day",
"idempotency_key": "rollout-may-001"
}
200 OKpayout.created
id"po_29ax8c2v"
status"approved"
settled_at"2026-05-15T14:22Z"
provider_ref"stripe_treas_8a91"
Capabilities

One record from first request to finance close

Shared payload contracts

Engineering, finance, and ops review the same POST body, response shape, and field assumptions before anyone writes code.

Webhooks rehearsed before launch

Replay payout.completed, payout.failed, and retry events. Inspect responses and prove handler logic before production traffic.

Close fields locked before scope freeze

Provider references, status history, and ERP export columns finalized early so finance signs off ahead of build.

Trust artifacts ready at scoping

Coverage maps, data-handling summaries, and controls documentation attached during evaluation so procurement reviews start immediately.

Examples built around real payloads

Payload examples include finance fields

Every request shape carries counterparty, amount, currency, provider references, and the close output finance needs on the same record.

Webhook docs cover retries and failures

Failed payouts, held records, retry logic, and the support actions that resolve each state are documented alongside the success path.

Export fields locked before scope freeze

Provider references, status history, fees, exception reasons, and ERP fields are mapped early so finance signs off before build starts.

Integration readiness

Four checks your team should complete before launch

01
Map
POST fields and response shapes
02
Replay
Webhook events and retry windows
03
Export
Close fields and ERP columns
04
Review
Trust pack and rollout checklist
Capabilities

Tools and artifacts you ship with today

API payload builder

Construct POST /payouts and POST /collections requests with typed fields. Compare response shapes side by side before writing integration code.

Webhook simulator

Replay payout.completed, payout.failed, and collection.received events. Inspect responses and rehearse retry paths before production traffic.

Integration patterns

Choose REST API, webhook-driven, file import, or hybrid. Each pattern includes a sequence diagram, team responsibilities, and rollout timeline.

Implementation examples

Working request/response pairs for contractor payouts, virtual-account collections, mass-payout batches, and reconciliation exports.

Trust and coverage pack

Regional coverage maps, data residency summaries, and controls documentation in one packet for procurement and security reviews.

Close-fields reference

Provider references, status history, fees, and exception reasons mapped to your ERP export columns before scope freezes.

How it works

Lock one event contract, then layer in the rest

Frequently Asked Questions

What stacks do you integrate with?+
Teams commonly connect ERPs (NetSuite, SAP), HRIS platforms (Workday, BambooHR), identity providers, product databases, and finance data warehouses. Most integrations use REST APIs or webhooks. File imports work as a faster path for initial rollout.
Is there a sandbox environment?+
Start with the API payload builder and webhook simulator right now. For full sandbox credentials, schedule a call with engineering so the environment, data shape, and workflow scope match what your team needs to validate.
How do I test webhooks locally?+
The webhook simulator replays events like payout.completed and payout.failed to any endpoint you configure, including localhost via ngrok or Cloudflare Tunnel. Use it to rehearse retries, failure states, and downstream finance handling before production traffic.
Where are the OpenAPI specs and code samples?+
Endpoint schemas, typed request/response shapes, and working examples are available in the payload builder. Full OpenAPI spec downloads and implementation walkthroughs are scoped during evaluation.
How long does a typical integration take?+
Teams that start with a single payout flow or file import ship faster than teams connecting every system at once. Layer in API-driven flows, SSO, and multi-system syncs after the first workflow and its exception path are validated.
What should we validate before engineering starts?+
Lock the POST fields, webhook event types, retry windows, idempotency keys, finance export columns, owner map, trust packet, and first rollout boundary. That keeps the build from becoming a moving target.

Ready to test the first payload?

Open the API payload builder to construct requests now, or schedule a call with engineering to scope endpoints, webhook events, and rollout.

Many teams start with a narrow launch in weeks.