Skip to content
F
v1.1.0
Developer Documentation

Flamingo Pay API.

Integrate QR-based instant payments into your platform. Accept PayShap payments from any South African bank, manage merchants, handle disputes, and stay POPIA-compliant.

Authentication

Most public endpoints (dispute filing, DSAR submission, receipt lookup) require no authentication. Merchant-authenticated endpoints require a valid merchant login session.

PublicNo authentication required
API KeyRequires API key in header
MerchantRequires merchant authentication

Merchant login example

bash
curl -X POST https://www.flamingopay.co.za/api/auth/merchant-login \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+27721234567",
    "pin": "1234"
  }'

Status Codes

200

OK

Request successful

201

Created

Resource created successfully

400

Bad Request

Invalid or missing parameters

401

Unauthorized

Authentication required or invalid

404

Not Found

Resource does not exist

429

Too Many Requests

Rate limit exceeded (20 req/min)

Error response format

json
{
  "error": "Description of what went wrong",
  "code": "VALIDATION_ERROR"
}

Merchant Onboarding

4 endpoints

Merchant Authentication

3 endpoints

Merchant Account

1 endpoint

Payments

4 endpoints

Webhooks

2 endpoints

Disputes

3 endpoints

POPIA Data Requests

3 endpoints

Documents

1 endpoint

Complaints

1 endpoint

Notifications

1 endpoint

Need help integrating?

Our team is here to help you build on top of Flamingo Pay.