Skip to main content

Overview

Last general docs update: 2026-05-22

This API is used to:

  • accept customer payments (pay-ins / collections),
  • send payouts to customers, partners, or beneficiaries (pay-outs / disbursements),
  • track payment lifecycle via webhooks and status polling.
Accepting payments for your projects in Africatranscore.io

What you need before integration

  • API keys (pk_* for public endpoints, sk_* for signed merchant operations).
  • IP allowlist/whitelist settings aligned with your integration environment: Whitelist.
  • A webhook URL configured for your merchant.
  • A stable merchantReference strategy on your side.

Quick start (5 steps)

  1. Configure auth and keys: Authentication
  2. Review request/response rules: Conventions
  3. Discover the markets enabled for your account with GET /merchant/api/v1/catalog: identify the country, currency, and method family for the flow you are implementing
  4. Implement the selected flow and request details: Flows, Endpoints, Payment methods, Coverage, Mobile money, Vouchers, Mobile money operators, and Balances
  5. Add webhook verification and idempotent processing: Webhooks

Integrator workflow

  • Use sidebar navigation for structured reading by topic.
  • Use Cmd/Ctrl + K search for terms such as Authentication, Webhook, PAYMENT_METHOD, balances.
  • Use the page Copy menu to copy or open the current page markdown in ChatGPT/Claude.

Environments

The API is available in separate environments. Use the base URL assigned to your integration.

Typical base URLs:

  • Development: https://merchants-api.payli.dev
  • Production: https://merchants-api.tcpay.io

All endpoints are relative to the base URL and start with:

  • /merchant/api/v1/...

Available countries, currencies, and method families depend on the environment and your merchant account. Start with GET /merchant/api/v1/catalog to identify the markets enabled for your integration, then use the relevant bank or operator discovery endpoint with the same request context you will use for the payment flow. Use Payment methods and Flows to build the final request payloads.

Documentation structure