Prepare your workspace

The dashboard setup checklist is complete when your workspace has a business name and checkout logo, at least one active receiving account, and an API key.

1 · Business Details

Set the name and logo displayed on hosted checkout.

2 · Receiving accounts

Add the accounts where customers send money.

3 · Developer settings

Create keys and register approved return origins.

Optional · Webhooks

Automate deposit outcomes with signed events.

Optional · Image Processing

Opt in to receipt QR and OCR, then review credits and usage.

Business Details

Business name and logo are required for setup readiness. Upload PNG, JPEG, or WebP up to 7 MB. Phone, website, and support URL are recommended customer-trust fields, but they are not readiness gates.

Receiving accounts

New accounts are active as soon as the merchant creates them. The supported providers are:

Provider	Dashboard value
Telebirr	`telebirr`
M-PESA	`mpesa`
Commercial Bank of Ethiopia	`cbe`
Bank of Abyssinia	`boa`
CBE Birr	`cbebirr`
Dashen Bank	`dashen`
Awash Bank	`awash`
Siinqee Bank	`siinqee`
Kaafi eBirr	`kaafiebirr`

Use the dashboard's displayed workspace and provider limits as the current limit for your account. Disable or replace an account you no longer control; deposits can only route to active accounts.

Name keys by service or environment boundary, grant only required scopes, and copy each vchk_… secret when it is created. Use separate keys for separate deployments so one can be rotated without interrupting the others.

Return URL domains

Register the origin, not a path: https://shop.example.com authorizes https://shop.example.com/payments/return. Scheme, hostname, and port must match. Subdomains are separate origins. HTTP is restricted to loopback development.

Domain activation is required

A saved but inactive return origin does not authorize deposit creation. Activate it before sending a matching return_url.

llms.txt llms-full.txt