Skip to main content

​
Overview

Payfonte provides APIs for three core capabilities:
  • Collections: create payment checkouts, run direct charge, and verify transactions.
  • Disbursements: validate recipients, request transfers, list disbursements, and verify disbursement status.
  • Wallets: fetch wallet balances by country and currency.
The API spec defines 11 operations across collection, disbursement, and wallet flows.

​
Base URLs

Use the right server for your environment:
EnvironmentBase URL
Sandboxhttps://sandbox-api.payfonte.com
Productionhttps://api.payfonte.com

​
Authentication

All endpoints require two API key headers (not Bearer token auth):
  • client-id
  • client-secret
curl --request GET 'https://sandbox-api.payfonte.com/payments/v1/checkouts' \
  --header 'client-id: <your-client-id>' \
  --header 'client-secret: <your-client-secret>'

​
Endpoint Map

​
Collections

MethodPathPurpose
POST/payments/v1/checkoutsGenerate checkout URL
GET/payments/v1/checkoutsList checkout transactions (paginated)
POST/payments/v1/payments/direct-chargeDirect charge via provider
GET/payments/v1/payments/direct-charge/{provider}/propertiesFetch provider-specific properties
GET/payments/v1/payments/verify/{reference}Verify a collection transaction

​
Disbursements

MethodPathPurpose
GET/billing/v1/transfer-recipients/{provider}/propertiesFetch recipient/provider properties
POST/billing/v1/transfer-recipients/validateValidate transfer recipient
POST/billing/v1/disbursementsRequest a disbursement
GET/billing/v1/disbursementsList disbursement transactions (paginated)
GET/billing/v1/disbursements/verify/{reference}Verify disbursement status

​
Wallets

MethodPathPurpose
GET/billing/v1/walletsFetch wallet balances

​
Common Request Conventions

  • Amount format: send amount in the lowest denomination (subunit). Example: 100.00 USD is sent as 10000.
  • Currency: 3-character code (for example NGN, USD, XOF, XAF).
  • Country: 2-character code (for example NG, US, CI, SN).
  • Reference: merchant-generated transaction reference should be unique per request.
  • Webhook override: selected endpoints accept a per-request webhook URL override.

​
Typical Workflows

​
Collections flow

  1. Create a checkout (POST /payments/v1/checkouts) or run direct charge (POST /payments/v1/payments/direct-charge).
  2. Receive transaction updates via webhook and/or poll verification (GET /payments/v1/payments/verify/{reference}).
  3. Use list endpoint (GET /payments/v1/checkouts) for reconciliation and reporting.

​
Disbursements flow

  1. Fetch provider properties (if required) and validate recipient (POST /billing/v1/transfer-recipients/validate).
  2. Request disbursement (POST /billing/v1/disbursements).
  3. Verify status (GET /billing/v1/disbursements/verify/{reference}) and reconcile with list endpoint (GET /billing/v1/disbursements).

​
Pagination and Filters

List endpoints support pagination with page and limit. Collection and disbursement list endpoints also support date filters (dateFrom, dateTo).

​
Support