Get consumer payment availability
LogsGET /payment-availability
Whether each utility the consumer belongs to can take payments yet
Tells the client, per tenant where the caller has an account, whether payments are enabled and which checkout methods can be offered right now, each saying whether it needs the payer's phone. When checkouts go through payment connectors, only methods a connector heard from in the last 90 seconds declares operational are listed, so a client never offers a method the checkout would refuse. The response also lists the methods for which the tenant accepts proofs of payment.
Returns
200 One row per tenant the consumer holds an account in
Show attributes
dataShow child attributes
tenant_idavailablemethodsCheckout methods a live payment connector can complete now, as the method codes the connectors declare. Absent when checkouts don't go through connectors; empty when none is live.
checkout_methodsMethods the consumer can pay with in the app now; clients offer these and nothing else. Empty while payments are unavailable or no connector is live.
Show child attributes
coderequires_phonelabelThe utility's own label for the collection channel of this method (the operator's label, or a neutral sample label in a test account); never derived from the code. Absent when no channel names it.
proof_methodsThe utility's enabled collection channels a consumer can pay through outside the app and then send a proof of payment for.
curl -X GET "$CONSUMER_API/payment-availability" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$CONSUMER_API/payment-availability", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$CONSUMER_API/payment-availability",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$CONSUMER_API/payment-availability", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"available": true,
"methods": [
"method"
],
"checkout_methods": [
{
"code": "COD-2026-000142",
"requires_phone": true,
"label": "label"
}
],
"proof_methods": [
"proof method"
]
}
]
}