Skip to main content
GET
/
v1
/
checkouts
# All active NGN checkouts
curl -G https://api.kwugwo.africa/v1/checkouts \
  -H "Authorization: Bearer $KWUGWO_SECRET_KEY" \
  --data-urlencode "filter[status][]=1" \
  --data-urlencode "filter[currency][]=NGN"

[
  {
    "uid": "chk.VCvr.7K2qPmRtV9xLnQ8sD1cYwHfE",
    "name": "Main checkout",
    "currency": "NGN",
    "status": "active",
    "mediums": [
      { "medium": "bank_transfer", "position": 0, "is_default": true },
      { "medium": "ussd", "position": 1, "is_default": false }
    ]
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.kwugwo.africa/llms.txt

Use this file to discover all available pages before exploring further.

Returns the checkouts you have configured in the dashboard, optionally filtered by status and currency. Use a checkoutā€™s uid as the checkout parameter on Create an ugwo to route the payment through that checkoutā€™s specific rules.
Checkouts are created and edited from the dashboard, not from this API. This endpoint is read-only.

ā€‹
Query parameters

ā€‹
filter[status][]
integer[]
Status filter, repeatable. 1 = active, 2 = inactive. Defaults to active + inactive when omitted.
ā€‹
filter[currency][]
string[]
Currency filter, repeatable. ISO-4217 codes (NGN, GHS, ā€¦).

ā€‹
Response

Returns an array of checkout objects (no pagination at this endpoint ā€” a workspace rarely has more than a handful).
ā€‹
uid
string
Checkout ID (chk.ā€¦).
ā€‹
name
string
Human-readable name from the dashboard.
ā€‹
currency
string
ISO-4217 currency code.
ā€‹
status
string
active or inactive.
ā€‹
mediums
object[]
Mediums enabled on this checkout, ordered by position. Each entry has medium, position, is_default.
# All active NGN checkouts
curl -G https://api.kwugwo.africa/v1/checkouts \
  -H "Authorization: Bearer $KWUGWO_SECRET_KEY" \
  --data-urlencode "filter[status][]=1" \
  --data-urlencode "filter[currency][]=NGN"

[
  {
    "uid": "chk.VCvr.7K2qPmRtV9xLnQ8sD1cYwHfE",
    "name": "Main checkout",
    "currency": "NGN",
    "status": "active",
    "mediums": [
      { "medium": "bank_transfer", "position": 0, "is_default": true },
      { "medium": "ussd", "position": 1, "is_default": false }
    ]
  }
]