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. A sandbox key is issued by Payloom: ask at hello@usepayloom.com.

2. Choose an environment

   Environment	Base URL	Keys
   Production	https://api.usepayloom.com/api/v1	clm_live_…
   Sandbox	https://sandbox-api.usepayloom.com/api/v1	clm_test_…

   The sandbox has its own database, sends no email and pays nobody, so you can build and test without touching a real payroll. The API playground (partners) sends its requests there.

3. Make a verification call

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

   curl

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

   Response

   {
     "id": "0b6f2c1e-8a3d-4f5e-9c21-7d4e5a6b8c90",
     "object": "organization",
     "name": "Kwame Foods Ltd",
     "country_code": "GH",
     "default_currency": "GHS",
     "status": "active",
     "kyc_status": "verified",
     "created_at": "2026-09-01T09:00:00Z"
   }

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. Partners have the full API reference for every endpoint.

Partners then subscribe to webhooks so their systems hear when a run is calculated, approved and paid, instead of polling for it. For a partner username and password, write to hello@usepayloom.com.