Weav Docsv1
Back to homeSupportGet API keys

API reference / Overview

API reference

View as Markdown
More actions
Open in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in GrokAsk questions about this pageConnect to CursorInstall the MCP server in CursorConnect to VS CodeInstall the MCP server in VS Code

Every endpoint, with its parameters, responses and code samples. Requests go to https://api.weavpayments.com with your API key as a Bearer token. See Authentication. Example values are samples, fees included: your fees are in your agreement with Weav.

Checkouts

The quickest way to get paid. One link for an order or an amount; your customer chooses how to pay on Weav's page.

Payments

Create a payment on one channel, then follow it to a final status.

Payment methods

Save a customer's card once, then charge it with no payer present (auto-debit, subscriptions).

Balance

Your available balance, what's on hold, and every change to it.

Withdrawals

Transfers from your balance to your payout account. Created in the dashboard.

Channels

Which payment channels your account can use right now.

Webhooks

Your webhook URL, the events Weav sends to it, and reposting them.

Try it

Each endpoint’s page has Try it, next to the endpoint’s path. It opens a playground: fill in the request on the left, and see it as cURL and Weav’s answer on the right, with the status, time, size and headers. Press ⌘↵ (Ctrl+Enter) to send.

  • Test keys only. It takes a wv_test_ key and refuses a live one, and so does the API: a live key sent from a browser gets 403 with code 4030001.
  • Your key stays in this tab. It’s kept in memory while you move between pages here, never saved, and gone when you reload or close the tab. Forget it clears it sooner. No cookies go with the request.
  • Copy it as cURL. The cURL view uses $WEAV_API_KEY, never your key. Paste it into a terminal, or import it into Postman.
  • It’s a real test-mode request. A payment you create is a real test payment in your account, and its webhooks go to your test webhook URL.
  • A key limited to an IP allowlist gets 403 here: your browser’s address isn’t on the list.

For your tools

This reference is made from Weav’s OpenAPI 3.1 file. Import openapi.yaml or openapi.json into Postman (Import → Link), Insomnia, Swagger UI or a code generator. For AI assistants: llms.txt and llms-full.txt.