Quickstart

From credentials to a cashflow figure in four calls. Replace <client-id> / <client-secret> with your project’s credentials.

Verify your credentials


curl https://api.pouchlimited.com/api/v1/business/health \
  -H "x-client-id: <client-id>" \
  -H "x-client-secret: <client-secret>"

A 200 confirms your credentials are valid.

List your customers


curl https://api.pouchlimited.com/api/v1/business/customers \
  -H "x-client-id: <client-id>" \
  -H "x-client-secret: <client-secret>"

Read a customer’s cashflow


curl "https://api.pouchlimited.com/api/v1/business/customers/123/cashflow" \
  -H "x-client-id: <client-id>" \
  -H "x-client-secret: <client-secret>"


{
  "data": { "income": 500.0, "expense": 320.5, "remaining": 179.5 }
}

Correct a transaction (optional)


curl -X POST \
  "https://api.pouchlimited.com/api/v1/business/customers/123/transactions/98765/exclude" \
  -H "x-client-id: <client-id>" \
  -H "x-client-secret: <client-secret>" \
  -H "Content-Type: application/json" \
  -d '{ "scope": "single" }'

Next: the Cashflow overview explains how income, expense and remaining are computed.