Skip to main content
Checkout links give you a hosted payment page that you can share with customers via email, SMS, or your website. When a customer clicks the link, they see a branded payment page and can complete their payment without you needing to build any frontend. Dubu automatically reconciles the payment against your account and, if the link is tied to an invoice, marks that invoice as paid. All routes require authentication.
string
Unique checkout link identifier (UUID).
string
Display title shown on the hosted payment page.
string
Optional description shown to the customer. null if not set.
string
The hosted checkout URL your customers visit to complete payment. Share this link directly.
string
URL-friendly identifier used in the hosted page URL. Lowercase alphanumeric with dashes.
string
one_time for a standalone payment or invoice for a link tied to an existing invoice.
number
Payment amount for one_time links.
string
Payment currency: NGN or USD.
string
active or inactive. Inactive links cannot be used for new payments.
string
URL customers are redirected to after a successful payment. null if not set.
string
Custom message shown to customers after payment. null if not set.
string
UUID of the linked invoice, if type is invoice. null otherwise.
string
ISO 8601 creation timestamp.
You can create three flavors of checkout link:
  • One-time amount — set type: "one_time" and provide amount and currency.
  • Invoice-linked — set type: "invoice" and provide invoice_id to link an existing invoice.
  • Inline invoice — provide customer_name, customer_email, and line_items to create a new invoice and checkout link in one call.

Request body

string
required
Title shown on the checkout page. Maximum 255 characters.
string
Optional description shown to the customer. Maximum 2,000 characters.
string
one_time or invoice. Defaults to one_time.
string
Custom URL slug for the checkout page (e.g. my-product-payment). Must be lowercase alphanumeric with dashes, 3–100 characters. Auto-generated if omitted.
string
NGN or USD. Defaults to your account currency.
string
URL to redirect the customer to after successful payment.
string
Custom message displayed after payment completes. Maximum 500 characters.
number
Fixed payment amount. Required for one_time links without line_items.
string
UUID of an existing invoice to link. Use this for invoice type links.
string
Customer name for inline invoice creation.
string
Customer email for inline invoice creation.
array
Line items for inline invoice creation. Each item requires description, quantity, and unit_price. Optionally include product_id to link a catalog product.

Example — one-time payment

Example response

Returns a paginated list of your checkout links.

Query parameters

string
Filter by status: active or inactive.
number
Page number (1-indexed).
number
Results per page. Maximum 100.

Example

Retrieve a single checkout link by its UUID.
string
required
UUID of the checkout link.
Update a checkout link’s display settings or status. You cannot change the amount, currency, or linked invoice after creation.
string
required
UUID of the checkout link to update.
string
New title.
string
New description. Pass null to clear.
string
New redirect URL. Pass null to remove.
string
New success message. Pass null to clear.
string
Set to inactive to disable the link, or active to re-enable it.

Example

Permanently deletes a checkout link. The hosted URL immediately stops working. This action cannot be undone.
string
required
UUID of the checkout link to delete.