Weav Docsv1
Back to homeSupportGet API keys

API reference / Balance

List ledger entries

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
GET/v1/ledger-entries

Every change to your available balance, newest first.

Each entry is permanent. A correction is a new entry, never an edit.

Query parameters

  • per_pageinteger
    Items per page, 25 by default; values above 100 become 100.
    At least 1Default: 25
  • cursorstring
    The next_cursor or prev_cursor from the previous page.
    Up to 1024 characters
  • date_fromstring (date)
    Start date (Asia/Manila), inclusive. Send with date_to.
  • date_tostring (date)
    End date (Asia/Manila), inclusive.
  • typestring
    Only entries of this type.
    One of: PAYMENT REFUND REVERSAL WITHDRAWAL WITHDRAWAL_RETURNED FEE ADJUSTMENT

Headers

  • AuthorizationstringRequired
    Bearer plus your API key. See Authentication.

Responses

200 OK

A page of ledger entries.

What data holds
  • ledger_entriesarray of objects
    8 fields in ledger_entries
    • reference_idstring
    • typestring
      PAYMENT, REFUND, REVERSAL, WITHDRAWAL, WITHDRAWAL_RETURNED, FEE or ADJUSTMENT.
      One of: PAYMENT REFUND REVERSAL WITHDRAWAL WITHDRAWAL_RETURNED FEE ADJUSTMENT
    • currencystring
      ISO 4217. PHP today; more as they're enabled for your account.
      One of: PHP
    • amountnumber
      Signed.
    • balance_afternumber
      Your balance after this entry.
    • sourceobject | null
      type (PAYMENT, REFUND, REVERSAL or WITHDRAWAL) and reference_id of what caused it. Null when nothing did, such as an adjustment.
      2 fields in source
      • typestring
        One of: PAYMENT WITHDRAWAL REFUND REVERSAL
      • reference_idstring
    • descriptionstring | null
      A readable label, mainly for adjustments.
    • posted_atstring (date-time)
      When the entry took effect.
  • paginationobject
    4 fields in pagination
    • per_pageintegerRequired
    • next_cursorstring | nullRequired
    • prev_cursorstring | nullRequired
    • is_last_pagebooleanRequired

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.

GET

Try it: List ledger entries

Test mode
Authorization
Query Optional
cURL
Uses $WEAV_API_KEY, never your key. Paste it into a terminal, or import it into Postman.
Response
Send the request to see Weav's answer here.
curl -X GET https://api.weavpayments.com/v1/ledger-entries \
    -H "Authorization: Bearer $WEAV_API_KEY"
{
    "code": "2000000",
    "success": true,
    "message": "OK",
    "data": {
        "ledger_entries": [
            {
                "reference_id": "LE5Q2W8E4R6T1Y",
                "type": "PAYMENT",
                "currency": "PHP",
                "amount": 1250.0,
                "balance_after": 64835.17,
                "source": {
                    "type": "PAYMENT",
                    "reference_id": "PY7K3Q9M2X4TBA"
                },
                "description": null,
                "posted_at": "2026-10-26T10:15:40+08:00"
            }
        ],
        "pagination": {
            "per_page": 25,
            "next_cursor": null,
            "prev_cursor": null,
            "is_last_page": true
        }
    }
}