Payments (Ugwo)
Create an ugwo
Create a new payment request.
POST
Creates a payment request (an ugwo) on the workspace that owns
your secret key. The ugwo starts in the
requires_ugwo status;
running a charge activity against it moves
it through the rest of its lifecycle.
Body parameters
Amount to charge, in the smallest currency unit (kobo for
NGN,
pesewas for GHS, cents for USD).ISO-4217 currency code. Must be a supported
currency and must be enabled on at least one
of your PSPs.
ID of an existing customer (
ony.…). When set, the ugwo is
attached to that customer and the merchant dashboard groups it under
their record.If onye is omitted, the workspace (nzube) must have a default
payment email configured in its settings; otherwise the request
fails with 422.Email address used to resolve the customer when
onye is not
provided. Must be a valid email. If an onye with this email already
exists on the workspace, that onye is attached to the ugwo;
otherwise a new onye is created with this email and attached.Ignored when onye is provided. If neither onye nor onye_email
is provided, the workspace’s default payment email is used (see
onye above).Your own reference (max 150 chars), typically an order number or
invoice ID. Echoed back on the ugwo and on webhook deliveries.Case-sensitive.
"Id" and "id" are stored and looked up as
distinct values.Human-readable description (max 150 chars) shown to the customer on
the hosted checkout. Must not contain newline characters.
ID of a checkout (
chk.…). When set, the ugwo
is pinned to this checkout and Kwugwo’s automatic checkout routing
is bypassed; the workspace’s routing rules are ignored for this
ugwo.Free-form
{ string: string } map for your own tagging. Stored
verbatim and surfaced on the dashboard. Not shown to the customer.Response
The new ugwo’s ID (
ugw.…). Persist this on your order.Amount in smallest currency unit.
ISO-4217 code.
Always
requires_ugwo for a freshly created ugwo.Your reference, if you sent one.
Description, if you sent one.
Echoed metadata.
The attached customer, if any (
null otherwise).The attached checkout, if any.
ISO-8601 timestamp.

