BlockWyre’s
Documentation
Everything you need to build on BlockWyre’s AI-driven financial infrastructure — from your first API call to production-grade custody, payments and off-ramp integrations.
30+
Currencies
99.99%
API uptime
<120ms
Median latency
REST
+ Webhooks
Getting started with BlockWyre
This section walks you through the initial setup and the key requirements for using our API. Grab your keys, make an authenticated request, and you’re live.
Create an account
Sign up and open the developer dashboard to provision your workspace.
Generate API keys
Create a secret key for the sandbox, then one for production.
Make your first call
Hit the /v1/ping endpoint to confirm your credentials work.
Go live
Switch the base URL to production and start moving value.
curl https://api.blockwyre.com/v1/ping \ -H "Authorization: Bearer sk_live_..." \ -H "Content-Type: application/json" // 200 OK{ "status": "ok", "region": "eu-west-1", "latency_ms": 42}Authentication
All requests are authenticated with a bearer token. Keep secret keys on the server side — never expose them in client code.
Treat your sk_live_ keys like passwords. Rotate them from the dashboard if one is ever exposed.
Understand the response model
Three concepts cover almost everything you’ll deal with day to day.
Standard
Responses
The BlockWyre API employs a consistent envelope across every endpoint, so successful and error payloads are always shaped the same way.
Learn moreCommon HTTP
Status Codes
A detailed overview of the HTTP status codes you might encounter, and exactly what each one signals about your request.
Learn moreError
Handling
On failure, a JSON response is returned containing a machine-readable code, a human message, and details to help you resolve the issue.
Learn moreCommon HTTP status codes
A detailed overview of the codes you might encounter and what each one means.
| Code | Meaning | |
|---|---|---|
| 200 | OKThe request succeeded and the response body contains the result. | The request succeeded and the response body contains the result. |
| 201 | CreatedA new resource — such as a transaction — was created. | A new resource — such as a transaction — was created. |
| 400 | Bad RequestThe request was malformed or missing required parameters. | The request was malformed or missing required parameters. |
| 401 | UnauthorizedThe API key is missing, invalid, or revoked. | The API key is missing, invalid, or revoked. |
| 429 | Too Many RequestsYou have exceeded the rate limit for your plan tier. | You have exceeded the rate limit for your plan tier. |
| 500 | Server ErrorSomething went wrong on our side. Retry with backoff. | Something went wrong on our side. Retry with backoff. |
Error handling
In case of an error, a JSON response is returned containing a message and, when possible, additional details to help resolve the issue.
// 400 Bad Request{ "error": { "code": "invalid_currency", "message": "'XYZ' is not a supported currency.", "param": "currency", "doc_url": "https://docs.blockwyre.com/errors" }}BlockWyre’s Sandbox
A robust sandbox environment designed for testing and integration with various third-party services. Safely experiment with transaction flows, API integrations and other functionality before your live deployment.
- Simulated balances and instant settlement
- Webhook replay and event inspection
- Zero real funds, production-identical API
# Point requests at the sandboxBLOCKWYRE_BASE_URL= \ "https://sandbox.blockwyre.com/v1" # Test key (safe to log)BLOCKWYRE_KEY=sk_test_9f2c...e10Need more help?
Our team responds within one business day. Reach out and we’ll get you unblocked.