Server API

Balance & payouts

What Mercestack holds for you, and what has been paid to your bank.

New collections settle into the platform's Bachs balance. Mercestack's append-only workspace ledger tracks what is owed after provider and platform fees. Money is pending for the settlement hold, then available. The workspace owner requests a payout in Payments → Payouts; an administrator reviews it and Bachs sends it to the registered bank destination.

Get your balance

GET/v1/balance

Secret keypayouts:read

One row per currency.

curl https://api.mercestack.com/v1/balance \
  -H "Authorization: Bearer sk_test_…"

Response

{
  "object": "balance",
  "balances": [
    {
      "currency": "NGN",
      "available": "124500.00",
      "availableMinor": "12450000",
      "pending": "18000.00",
      "pendingMinor": "1800000",
      "paidOut": "820000.00"
    }
  ]
}

List payouts

GET/v1/payouts

Secret keypayouts:read

requested → processing → paid, or rejected / failed (the amount goes back to your balance).

curl https://api.mercestack.com/v1/payouts \
  -H "Authorization: Bearer sk_test_…"

Response

{
  "object": "list",
  "data": [
    {
      "id": "p_91…",
      "amount": "450000.00",
      "currency": "NGN",
      "status": "paid",
      "account": { "bankName": "GTBank", "accountName": "ACME LTD", "accountNumberMasked": "••••6789" },
      "paidAt": "2026-09-20T09:00:00.000Z",
      "createdAt": "2026-09-19T15:00:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}

Server API

Balance & payouts

What Mercestack holds for you, and what has been paid to your bank.

Get your balance

GET/v1/balance

Secret keypayouts:read

One row per currency.

curl https://api.mercestack.com/v1/balance \
  -H "Authorization: Bearer sk_test_…"

Response

{
  "object": "balance",
  "balances": [
    {
      "currency": "NGN",
      "available": "124500.00",
      "availableMinor": "12450000",
      "pending": "18000.00",
      "pendingMinor": "1800000",
      "paidOut": "820000.00"
    }
  ]
}

List payouts

GET/v1/payouts

Secret keypayouts:read

requested → processing → paid, or rejected / failed (the amount goes back to your balance).

curl https://api.mercestack.com/v1/payouts \
  -H "Authorization: Bearer sk_test_…"

Response

{
  "object": "list",
  "data": [
    {
      "id": "p_91…",
      "amount": "450000.00",
      "currency": "NGN",
      "status": "paid",
      "account": { "bankName": "GTBank", "accountName": "ACME LTD", "accountNumberMasked": "••••6789" },
      "paidAt": "2026-09-20T09:00:00.000Z",
      "createdAt": "2026-09-19T15:00:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}