Zoe Pay API

Bearer key from Portal → Developers. Envelope is success / data / error. Refunds are operator-marked until OmniBsic reversal exists.

openapi.jsonOverview
openapi.json
openapi: 3.1.0
title: Zoe Pay API
paths: 10
Buyers pay withMTN MoMoTelecel CashAT MoneyVisaMastercardMachine copy at /api/v1/openapi.json

Every v1 route

Products, orders, payments, refunds and balance. No /api/v1/customers in this spec.

  • POST/api/v1/paymentsCreate a paymentpayments:write
  • GET/api/v1/payments/{ref}Read a paymentpayments:read
  • POST/api/v1/payments/{ref}/momoSend the MoMo approval prompt to the buyer's phone (POS tills)payments:write
  • POST/api/v1/checkout/intentCreate a popup checkout intentpayments:write
  • GET/api/v1/balanceRead available balancebalance:read
  • POST/api/v1/refundsRequest a refund (manual payout)refunds:write
  • GET/api/v1/productsList productsproducts:read
  • POST/api/v1/productsCreate a productproducts:write
  • GET/api/v1/products/{id}Read a productproducts:read
  • GET/api/v1/ordersList ordersorders:read
  • GET/api/v1/orders/{ref}Read an orderorders:read

success, data, error. Nothing else

401 without a key. insufficient_scope when the Bearer is missing a grant.

  • Products, orders, payments, refunds, balance.
  • No /api/v1/customers in this spec.
  • Simulate header on writes that support it.
Overview

GH₵ 76.70

You keep

A key still comes from Portal → Developers

This page is the map. Access is not self-serve.

Zoe PayRequest access

  • Instant MoMo

    Available the same day.

  • 3.5% + GH₵0.50

    Free plan. No monthly fee.

  • No GH₵7

    No extra withdrawal fee.

Embed, WordPress, terms

Your store can be live today.

Free to start. One fee when a buyer pays. Sell before KYC, withdraw to MoMo once your Ghana Card is approved.

Start freeTalk to us