Volboo Docs
Home Pricing Dashboard

Getting started

Quickstart

Five steps from a fresh account to a collection you can see land. Budget about twenty minutes, most of it waiting for your business to be verified.

The path

1

Create your business

Sign up, add the business and complete the compliance profile. Live collections stay closed until the business is active, but your sandbox keys work straight away.

2

Take your keys

Dashboard, then Business Setting → API Keys. You get an API key and a secret key per environment. See Authentication for how they are sent.

3

Point a webhook at your server

Under Business Setting → Webhook, set the URL that should receive completed payments. It has to be reachable over HTTPS and answer quickly.

4

Create a virtual account

One call, and you have an account number to show the customer. The reference you pass is the one that comes back to you on every payment into it.

5

Collect, then verify

Pay into the account, or fire the sandbox simulator. Your endpoint receives payment.success; you confirm it against the transaction endpoint and credit the customer.

Your first call

This creates a virtual account. If it returns status: "success", your credentials, your business and your environment are all correct, which makes it a good first thing to run.

Create a virtual account 
curl -X POST https://<volboo-host>/v1/create_account \
  -H "Content-Type: application/json" \
  -H "api-key: <your api key>" \
  -H "secret-key: <your secret key>" \
  -d '{
    "email": "customer@example.com",
    "ref": "order_10432",
    "fname": "Amanda",
    "lname": "Elumelu"
  }'
Keep the secret key on your server. These calls are made from your backend. A key pair shipped in a mobile app or a web page can issue accounts and read transactions on your business.

Then what