Skip to content

API reference / Balance

Get your balance

View as Markdown

GET/v1/balance

Your available balance and what is on hold for withdrawals in progress.

Query parameters

currencystring
Defaults to your account's default currency.
One of: PHP

Headers

AuthorizationstringRequired
Bearer plus your API key. See Authentication.

Responses

200 OK

Your balance in one currency.

What data holds

balanceobject
4 fields in balance
- currencystring
  ISO 4217. PHP today; more as they're enabled for your account.
  One of: PHP
- availablenumber
  What you can withdraw.
- on_holdnumber
  Withdrawals on their way to your bank.
- as_ofstring (date-time) | null
  Time of the latest ledger entry.

401 Unauthorized

Missing, malformed or unknown API key (code 4010000).

403 Forbidden

The key can't make this request (code 4030000): an address outside the key's IP allowlist, a live key before your live mode is on, or an account that isn't active. A live key sent from a browser is refused (code 4030001): keep live keys on your server.

422 Unprocessable Content

One or more fields are invalid (code 4220000), or the channel is off (4220101) or doesn't take the currency (4220102).

curl -X GET https://api.weavpayments.com/v1/balance \
    -H "Authorization: Bearer $WEAV_API_KEY"

const url = 'https://api.weavpayments.com/v1/balance';
const response = await fetch(url, {
    method: 'GET',
    headers: {
        Authorization: `Bearer ${process.env.WEAV_API_KEY}`,
    },
});

const result = await response.json();

import axios from 'axios';

const response = await axios.request({
    method: 'get',
    url: 'https://api.weavpayments.com/v1/balance',
    headers: {
        Authorization: `Bearer ${process.env.WEAV_API_KEY}`,
    },
    // Read error answers too: their body has the error code.
    validateStatus: () => true,
});

const result = response.data;

use Illuminate\Support\Facades\Http;

$response = Http::withToken(config('services.weav.key'))
    ->get('https://api.weavpayments.com/v1/balance');

$result = $response->json();

import os
import requests

response = requests.get(
    "https://api.weavpayments.com/v1/balance",
    headers={
        "Authorization": f"Bearer {os.environ['WEAV_API_KEY']}",
    },
    timeout=30,
)

result = response.json()

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("GET", "https://api.weavpayments.com/v1/balance", nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+os.Getenv("WEAV_API_KEY"))

    res, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer res.Body.Close()

    result, err := io.ReadAll(res.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(res.Status, string(result))
}

// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = std::env::var("WEAV_API_KEY")?;

    let response = reqwest::blocking::Client::new()
        .get("https://api.weavpayments.com/v1/balance")
        .bearer_auth(key)
        .send()?;

    let status = response.status();
    let result: serde_json::Value = response.json()?;
    println!("{status} {result:#}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WeavExample {
    public static void main(String[] args) throws Exception {
        String url = "https://api.weavpayments.com/v1/balance";
        HttpRequest request =
                HttpRequest.newBuilder()
                        .uri(URI.create(url))
                        .header("Authorization", "Bearer " + System.getenv("WEAV_API_KEY"))
                        .GET()
                        .build();

        HttpResponse<String> response =
                HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

{
    "code": "2000000",
    "success": true,
    "message": "OK",
    "data": {
        "balance": {
            "currency": "PHP",
            "available": 64835.17,
            "on_hold": 119000.0,
            "as_of": "2026-10-26T10:15:40+08:00"
        }
    }
}

{
    "code": "4010000",
    "success": false,
    "message": "Missing or invalid API key."
}

{
    "code": "4030000",
    "success": false,
    "message": "Requests with this key must come from an address on its allowlist."
}

{
    "code": "4220000",
    "success": false,
    "message": "The given data was invalid.",
    "errors": {
        "channel": [
            "The channel field is required."
        ]
    }
}