Quickstart

Three steps to your first authenticated call.

1. Mint an API key

   In the Payloom console, a member holding integrations.manage opens Settings → Integrations and creates a key. The secret is shown once, so copy it then. A key carries a subset of that member’s own permissions, so scope it to what the integration needs.

2. Choose an environment

   Environment	Base URL	Keys
   Production	https://api.usepayloom.com/api/v1	plm_live_…
   Staging	https://staging-api.usepayloom.com/api/v1	plm_test_…

   Staging runs against demo data, so you can build and test without touching a real payroll.

3. Make a verification call

   GET /organization returns the organization your key belongs to. If it comes back, your key and environment are wired correctly.

   curl

   curl https://staging-api.usepayloom.com/api/v1/organization \
     -H "Authorization: Bearer plm_test_<id>_<secret>"

   Response

   {
     "id": "org_7f3a",
     "name": "Kwame Foods Ltd",
     "default_currency": "GHS",
     "kyc_status": "verified"
   }

What next

Run a month

Create a pay run with POST /pay_runs, calculate it with POST /pay_runs/:id/calculate, then read the payslips. See the API reference for every endpoint.

Then subscribe to webhooks so your systems hear when a run is calculated, approved and paid, instead of polling for it.