List the payment methods staff can record for this utility
LogsGET /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_activeFalse while the payments capability is not active; every method is then unavailable.
dataShow child attributes
codeMethod code sent when recording the payment.
labelThe 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.
channelCollection channel type the method comes from.
sourceone of
channel,connectorrequires_referencerequires_phonerequires_shiftCash taken at a counter; recorded from the cash desk during an open shift.
counterTaken at a counter (cash or a card terminal); the cash desk offers these.
connectorWhether a live connector of the utility can complete the method now, or only lists it. Absent when no connector offers it.
one of
operational,declaredavailableunavailable_reasonone of
channel_disabled,connector_unavailable,payments_inactive
Permissions business:prepaid:vend · Roles: admin, billing_clerk, finance, owner
curl -X GET "$BUSINESS_API/payment-methods" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/payment-methods", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/payment-methods",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/payment-methods", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"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"
}
]
}