wacaDevelopers

API reference · Money

Earnings

Your balance, every commission you earned and the payouts you received.

get/balance

Your balance

Businesses only

What you can be paid now, what is held until rentals and sales complete, and what has been paid out.

Response 200

In data:

  • currencystring
  • availableinteger

    Can be paid out now.

  • pendinginteger

    Held until the rental or sale is completed.

  • paidOutinteger

    Already transferred to your bank account.

Errors

  • 401unauthorized: the API key is missing, wrong or revoked.
  • 403forbidden: this key may not do that (wrong plan, not a business, or the account is not approved).
curl "https://engine-production-0004.up.railway.app/api/v1/balance" \
  -H "Authorization: Bearer wc_test_YOUR_KEY"
Response · 200
{
  "data": {
    "currency": "NGN",
    "available": 12500000,
    "pending": 4200000,
    "paidOut": 68000000
  }
}
get/commissions

List your commissions

Businesses only

Every commission you earned or gave back, with the booking or sale it came from. Live bookings only: sandbox activity never touches money.

Query parameters

  • statusstring

    held, released or reversal.

    heldreleasedreversal

  • fromstring

    Created on or after.

  • tostring

    Created before.

  • pageinteger

    Page number, from 1.

    Example: 1

  • limitinteger

    Items per page (1–100). Default 20.

    Example: 20

Response 200

A page: { data: [ … ], page, totalPages, total }. Each item in data:

  • idinteger
  • createdAtdate-time

    ISO 8601 date-time.

  • typeenum

    rentalsale

  • referencestring · nullable
  • kindenum

    earningreversal

  • statusenum

    heldreleasedreversal

  • amountinteger

    Negative for a reversal.

  • releasedAtdate-time · nullable

    ISO 8601 date-time.

  • notestring · nullable

Errors

  • 400invalid: something in the request is wrong. The message says what.
  • 401unauthorized: the API key is missing, wrong or revoked.
  • 403forbidden: this key may not do that (wrong plan, not a business, or the account is not approved).
curl "https://engine-production-0004.up.railway.app/api/v1/commissions?page=1&limit=20" \
  -H "Authorization: Bearer wc_test_YOUR_KEY"
Response · 200
{
  "data": [
    {
      "id": 91,
      "createdAt": "2026-11-20T09:05:00.000Z",
      "type": "rental",
      "reference": "WC-7KQ2M9XA",
      "kind": "earning",
      "status": "held",
      "amount": 2092500,
      "releasedAt": null,
      "note": "Booking WC-7KQ2M9XA"
    }
  ],
  "page": 1,
  "totalPages": 1,
  "total": 1
}
get/payouts

List your payouts

Businesses only

The transfers made to your bank account.

Query parameters

  • statusstring

    pending, paid or failed.

    pendingpaidfailed

  • pageinteger

    Page number, from 1.

    Example: 1

  • limitinteger

    Items per page (1–100). Default 20.

    Example: 20

Response 200

A page: { data: [ … ], page, totalPages, total }. Each item in data:

  • idinteger
  • referencestring
  • amountinteger

    Amount in kobo (₦1 = 100 kobo).

  • statusenum

    pendingpaidfailed

  • transferReferencestring · nullable
  • failureReasonstring · nullable
  • paidAtdate-time · nullable

    ISO 8601 date-time.

  • createdAtdate-time

    ISO 8601 date-time.

Errors

  • 401unauthorized: the API key is missing, wrong or revoked.
  • 403forbidden: this key may not do that (wrong plan, not a business, or the account is not approved).
curl "https://engine-production-0004.up.railway.app/api/v1/payouts?page=1&limit=20" \
  -H "Authorization: Bearer wc_test_YOUR_KEY"