Skip to main content
POST
Creates an ugwo, a request to collect amount from a customer. It starts as requires_ugwo. Then either hand its uid to the embedded checkout, or charge it from your own UI.
Always send ref (your order ID). It is unique per workspace, so a retried request with the same ref returns 409 instead of creating a duplicate payment. See Retries and idempotency.

Body parameters

integer
required
Amount to collect, in the smallest currency unit (kobo for NGN). Must be within the currency’s limits: for NGN, 20000 (₦200.00) to 5000000000 (₦50,000,000.00).
string
required
ISO-4217 code, e.g. NGN. Must be supported and enabled on at least one PSP in your workspace.
string
Your reference, up to 150 characters, typically the order ID. Unique per workspace and case-sensitive. Echoed on the ugwo and in every webhook.
string
Up to 150 characters, shown to the customer on the hosted checkout. No line breaks.
string
ID of an existing customer, ony.….
string
The payer’s email, used when you don’t pass onye. Kwugwo attaches the customer with this email, creating one if needed. Ignored when onye is set.If you send neither onye nor onye_email, the workspace’s default payment email (dashboard settings) is used; without one, the request fails with 422.
string
ID of a checkout, chk.…. Pins this payment to that checkout’s mediums and routing instead of letting your workspace routing rules choose.
object
Up to 50 { "key": "value" } pairs for your own use. Keys are strings; values are strings of up to 255 characters, or null. Returned on the ugwo; never shown to the customer.

Response

The new Ugwo object with status: "requires_ugwo". lastest_ugwo_activity is not included in this response.

Errors