Getting started

Volboo API

Collect money into dedicated account numbers, read what has been paid, and hear about it the moment it happens. The API is REST over HTTPS, speaks JSON both ways, and is authenticated with a key pair issued to your business.

What you can build

Virtual accounts

Issue an account number per customer, project or order, so a transfer identifies itself the moment it lands.

Webhooks

A POST to your endpoint on payment receipt and status change, so your system stays in step without polling.

Transactions

Query what has been collected, and verify any event you were sent before you act on it.

Authentication

Four headers on every call, with separate credentials for test and live.

How it fits together

A collection has three moments, and there is an endpoint or an event for each of them:

Before the money. You create a virtual account for the customer and show them the account number.
As it arrives. Your customer transfers to that number. Volboo POSTs a payment.success event to your webhook URL.
After. You verify the event against the transaction endpoint and credit the customer in your own system.

Base URL and paths

All API requests must be made to the following base URL:

Base URL

https://api.volboo.com/

Every path in these docs is relative to this base URL, for example /v1/user_banks resolves to https://api.volboo.com/v1/user_banks. Requests are JSON, and every response carries a status field you should branch on before reading anything else.

Working in test first. Your dashboard issues a separate key pair for the sandbox. Build against it, use the payment simulator to fire a collection, and switch the keys when you go live. Nothing else in your integration has to change.

Where to go next

If you are starting from nothing, the quickstart walks the whole path in five steps. If you only need the shape of one call, jump straight to creating an account.