Reference

API documentation

Create a payment link from your server, then send your customer to the returned checkout URL. Amounts are in major units, so 480.00 is four hundred and eighty.

Authentication

Send your secret key in the Authorization header. Test keys start with sk_test_ and live keys with sk_live_. Keys are hashed at rest and can be revoked from the API keys page.

Base URL

https://posh-ferret-868.convex.site

Create a payment link

POST /v1/payment-links

curl

curl -X POST https://posh-ferret-868.convex.site/v1/payment-links \\
  -H "Authorization: Bearer sk_test_your_key" \\
  -H "Content-Type: application/json" \\
  -d '{
    "title": "Ankara two-piece",
    "amount": 480.00,
    "currency": "GHS",
    "description": "Handmade, size M"
  }'

response 201

{
  "id": "k57d8x2m9q",
  "slug": "ankara-two-piece-a91f",
  "checkout_path": "/pay/ankara-two-piece-a91f",
  "checkout_url": "/pay/ankara-two-piece-a91f",
  "mode": "test"
}

Body parameters

title: string, requiredShown to the customer on the checkout page.
amount: number, requiredAmount in major units, greater than zero.
currency: string, optionalDefaults to your business currency.
description: string, optionalExtra detail shown under the title.

Amounts and fees

Send the business price as amount. Checkout adds a 2% customer fee on top. A 3% settlement fee is deducted when the payment settles, so your net is the business price minus 3%.

A test key creates test links. Test links never use the live payment connection. If test payments are not configured, checkout asks you to use a live link.

Redirect the customer

After creating a link, redirect the customer to the returned checkout path on your DE'WEB PAY address. Keep the secret key on your server and never put it in browser code.

Going live

Live card payments require business verification and a verified settlement account. Once approved, switch your keys and the same code starts charging real cards. Settlement requests to mobile money or bank are reviewed before funds are released.