Payment methods

Base URL: $BUSINESS_API

The object

codestring · required

Method code sent when recording the payment.

labelstring · optional

The utility's own name for the channel (the operator's label, or a neutral sample label in a test account), when a channel of this type has one; never derived from the code.

channelstring · optional

Collection channel type the method comes from.

sourcestring · required

one of channel, connector

requires_referenceboolean · required
requires_phoneboolean · required
requires_shiftboolean · required

Cash taken at a counter; recorded from the cash desk during an open shift.

counterboolean · optional

Taken at a counter (cash or a card terminal); the cash desk offers these.

connectorstring · optional

Whether a live connector of the utility can complete the method now, or only lists it. Absent when no connector offers it.

one of operational, declared

availableboolean · required
unavailable_reasonstring · optional

one of channel_disabled, connector_unavailable, payments_inactive

The object
{
  "code": "COD-2026-000142",
  "label": "label",
  "channel": "channel",
  "source": "channel",
  "requires_reference": true,
  "requires_phone": true,
  "requires_shift": true,
  "counter": true,
  "connector": "operational",
  "available": true,
  "unavailable_reason": "channel_disabled"
}

List the payment methods staff can record for this utility

Logs

GET /payment-methods

Derived from the utility's configured collection channels (mobile money, bank transfer, the cash counter) and from the methods its payment connectors declare; nothing is listed that the utility did not configure. Clients word each method from its code. Readable with payments:read, payments:write or business:prepaid:vend.

Returns

200 Methods for the authenticated utility tenant, in configuration order

Show attributes
payments_activeboolean · required

False while the payments capability is not active; every method is then unavailable.

dataarray of object · required
Show child attributes
codestring · required

Method code sent when recording the payment.

labelstring · optional

The utility's own name for the channel (the operator's label, or a neutral sample label in a test account), when a channel of this type has one; never derived from the code.

channelstring · optional

Collection channel type the method comes from.

sourcestring · required

one of channel, connector

requires_referenceboolean · required
requires_phoneboolean · required
requires_shiftboolean · required

Cash taken at a counter; recorded from the cash desk during an open shift.

counterboolean · optional

Taken at a counter (cash or a card terminal); the cash desk offers these.

connectorstring · optional

Whether a live connector of the utility can complete the method now, or only lists it. Absent when no connector offers it.

one of operational, declared

availableboolean · required
unavailable_reasonstring · optional

one of channel_disabled, connector_unavailable, payments_inactive

Errors 401 · 403

Permissions business:prepaid:vend · Roles: admin, billing_clerk, finance, owner

curl -X GET "$BUSINESS_API/payment-methods" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "payments_active": true,
  "data": [
    {
      "code": "COD-2026-000142",
      "label": "label",
      "channel": "channel",
      "source": "channel",
      "requires_reference": true,
      "requires_phone": true,
      "requires_shift": true,
      "counter": true,
      "connector": "operational",
      "available": true,
      "unavailable_reason": "channel_disabled"
    }
  ]
}