Skip to content
Tranzaq

Get started

Introduction

What the Tranzaq API does, how requests and answers look, and where to begin.

The Tranzaq API lets your own software do what your team does on the website: add the people you pay, create batches of payments, and follow every payment until it is paid or has failed. Everything is about paying people in Ghana by mobile money or bank, in Ghana cedis (GHS).

Base URL

All calls go to one address. Test and live use the same address; the credentials you sign in with decide which one you are talking to.

https://api.tranzaq.com

How answers look

Every call answers with JSON in the same envelope: success, a human message, the HTTP status again as code, and the data in result. The token call is the one exception, because OAuth defines its own format.

{
  "success": true,
  "message": "Operation completed",
  "code": 200,
  "result": { "available": 5000.00, "currency": "GHS" }
}

Conventions

  • Amounts are numbers in cedis with at most two decimal places, for example 1850.00.
  • Ids are UUIDs. Times are ISO 8601 with a time zone.
  • Names of fields are camelCase. Statuses are words, such as PendingApproval.
  • Lists are paged with page (from 1) and pageSize (1 to 100) and answer with items, total, page and pageSize.
  • Calls that create things need an Idempotency-Key header, so a retry never creates two of anything.

Where to go next