Browse the docs

Paygoro API · v1

Build on your Paygoro workspace

A versioned REST API over the data in your Paygoro workspace — legal entities, bank accounts and balances, transactions, bills and payees. Authenticate with a workspace API key and integrate with the accounting, reporting and payables tools you already run.

Quick start

  1. Create an API key. A workspace owner or admin opens Settings → Developers in Paygoro, picks the scopes the integration needs, and copies the key. It starts with pgk_ and is shown only once.
  2. Check the connection. Call GET /workspace — it needs no scope and echoes the key's permissions.
  3. Read some data. List transactions, then walk the pages with nextCursor.
bash
curl "https://api.paygoro.com/v1/workspace" \
  -H "Authorization: Bearer $PAYGORO_API_KEY"
200 · application/json
{
  "id": "acc_3f9c2a7e",
  "name": "Main account",
  "apiKey": {
    "id": "acc_3f9c2a7e",
    "name": "Main account",
    "scopes": [
      "transactions:read",
      "accounts:read"
    ]
  }
}
bash
curl "https://api.paygoro.com/v1/transactions?limit=50" \
  -H "Authorization: Bearer $PAYGORO_API_KEY"
Base URL: https://api.paygoro.com/v1. Every request is HTTPS and carries Authorization: Bearer pgk_. Money is always a decimal string, never a float; timestamps are UTC.

Resources

Everything in v1 hangs off the workspace your key belongs to. A workspace can hold several legal entities (companies); accounts, transactions, bills and payees each belong to one of them, and every list accepts a companyId filter.

Workspace

The workspace your key belongs to.

Companies

Legal entities in the workspace.

Accounts

Paygoro business accounts and connected external accounts.

Transactions

Bank transactions across all accounts.

Categories

Transaction categories.

Bills

Payable invoices in the bill-pay inbox.

Where to next

Browse the full reference