Docs/API Reference

Commercial terms & commissions

Read your contract terms and earnings summary, and reconcile the commission ledger for patients attributed to you.

Rehabify pays partners a commission on care delivered to the patients they refer. These two endpoints show your terms and every commission entry, so finance teams can reconcile payouts.

MethodPath
GET/partners/commercialRetrieve commercial terms
GET/partners/commissionsList commissions

All amounts are integers in kobo with "currency": "NGN". For example, 1500000 is ₦15,000.00.

How commissions work

  • What earns a commission. Verified paid bookings by patients attributed to you. A patient is attributed to you through an API referral, a referral link, or a WhatsApp referral code. Clicks, leads and sign-ups don't earn commission on their own.
  • Live only. Sandbox activity never earns commission.
  • Rate. Your signed contract sets the rate. If you don't have a signed contract, the platform default partner share applies, which is currently 10% of revenue.
  • Withholding tax is deducted as set out in your contract. net_payable_kobo is the commission after withholding tax.
  • Refunds reverse commissions. If the booking hasn't been paid out yet, its commission moves to reversed. If it has already been paid out, a negative adjustment is recorded instead.
  • Payouts are made monthly to your verified bank account. Each payout covers all approved commissions up to the billing period, minus the Paystack transfer fee and stamp duty.

Retrieve commercial terms

GET /partners/commercial

Returns your contract terms and an earnings summary.

200 OK
{
  "object": "commercial_terms",
  "contract": {
    "contract_number": "CTR-2026-001",
    "model": "percentage_revenue_share",
    "revenue_share_percent": 10,
    "base_fee_per_booking_kobo": null,
    "withholding_tax_percent": 5,
    "payment_terms_days": 30,
    "currency": "NGN",
    "effective_from": "2026-10-01T00:00:00.000Z",
    "is_default": false
  },
  "earnings": {
    "earned_kobo": 0,
    "pending_payout_kobo": 0,
    "paid_out_kobo": 0,
    "reversed_kobo": 0,
    "currency": "NGN"
  }
}
FieldTypeDescription
contract.contract_numberstring or nullYour contract reference.
contract.modelstringfixed_per_patient, percentage_revenue_share, hybrid or tiered_volume.
contract.revenue_share_percentnumber or nullYour share of revenue, as a percentage.
contract.base_fee_per_booking_kobointeger or nullA fixed amount per booking, for models that use one.
contract.withholding_tax_percentnumber or nullThe withholding tax rate deducted from commissions.
contract.payment_terms_daysinteger or nullThe payment terms in days.
contract.currencystringNGN.
contract.effective_fromstring or nullWhen the terms took effect.
contract.is_defaultbooleantrue when no signed contract exists and the platform default partner share applies. revenue_share_percent is then the platform partner percent, currently 10.
earnings.earned_kobointegerCommission earned to date.
earnings.pending_payout_kobointegerEarned but not yet paid out.
earnings.paid_out_kobointegerAlready paid to your bank account.
earnings.reversed_kobointegerReversed because of refunds.
earnings.currencystringNGN.

In sandbox, earnings are always zero.

curl https://api.physioaroundme.com/v1/partners/commercial \
  -H "Authorization: Bearer $REHABIFY_API_KEY"

List commissions

GET /partners/commissions

Returns your commission ledger as a paginated list. This endpoint is live only: in sandbox, it returns an empty list.

Query parameters

ParameterTypeDescription
statusstringpending, approved, paid, reversed or cancelled.
billing_periodstringA month in YYYY-MM format, for example 2026-10.
limitinteger1–100. Default 25.
cursorstringThe next_cursor from the previous page.

The commission object

{
  "object": "commission",
  "id": "kd2m4n6b8v0c1x3z5a7s9d2f4g6h8j0k",
  "referral_id": "jd7f3k2m9x1q8w4e5r6t7y8u9i0o1p2a",
  "tracking_code": "RHB-4829173655",
  "event_type": "payment",
  "gross_amount_kobo": 1500000,
  "commission_amount_kobo": 150000,
  "net_payable_kobo": 142500,
  "currency": "NGN",
  "status": "approved",
  "billing_period": "2026-10",
  "earned_at": "2026-10-15T10:05:00.000Z",
  "paid_at": null
}
FieldTypeDescription
objectstringAlways commission.
idstringCommission entry ID.
referral_id, tracking_codestringThe referral the commission relates to.
event_typestringWhat generated the entry, for example payment for a verified paid booking.
gross_amount_kobointegerThe amount the patient paid.
commission_amount_kobointegerYour commission before withholding tax.
net_payable_kobointegerYour commission after withholding tax.
currencystringNGN.
statusstringSee the table below.
billing_periodstringThe month the entry belongs to (YYYY-MM).
earned_atstringWhen the commission was earned.
paid_atstring or nullWhen it was paid out.

In this example, the patient paid ₦15,000.00. A 10% share gives ₦1,500.00, and 5% withholding tax leaves ₦1,425.00 net payable.

StatusMeaning
pendingRecorded, but not yet approved for payout.
approvedApproved and included in the next monthly payout.
paidPaid out to your bank account. paid_at is set.
reversedReversed because the booking was refunded.
cancelledCancelled. It won't be paid.
curl "https://api.physioaroundme.com/v1/partners/commissions?billing_period=2026-10&status=approved" \
  -H "Authorization: Bearer $REHABIFY_API_KEY"
200 OK
{
  "object": "list",
  "data": [
    {
      "object": "commission",
      "id": "kd2m4n6b8v0c1x3z5a7s9d2f4g6h8j0k",
      "referral_id": "jd7f3k2m9x1q8w4e5r6t7y8u9i0o1p2a",
      "tracking_code": "RHB-4829173655",
      "event_type": "payment",
      "gross_amount_kobo": 1500000,
      "commission_amount_kobo": 150000,
      "net_payable_kobo": 142500,
      "currency": "NGN",
      "status": "approved",
      "billing_period": "2026-10",
      "earned_at": "2026-10-15T10:05:00.000Z",
      "paid_at": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors: 400 invalid_parameter for an invalid status, billing_period or limit, plus the standard authentication errors.

Commercial terms & commissions | Rehabify Docs | Physio Around Me by Rehabify Health