Build with FinVeil.

A REST API with test-mode API keys. New accounts start in TEST mode on the production API, so you don't need a sales call to get a key.

Quickstart

From sign-up to your first test payment link.

quickstart.shbash
# 1. Register. Your account starts in TEST mode; the response carries an ADMIN access token.
curl -X POST https://api.finveil.money/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Acme (Pty) Ltd",
    "industry": "Retail",
    "employeeCount": 10,
    "firstName": "Thandi", "lastName": "Mokoena",
    "email": "you@acme.co.za",
    "password": "<AT_LEAST_12_CHARS_MIXED>",
    "popiaConsent": true,
    "countryCode": "ZA"
  }'

# 2. Mint a test API key. The raw key (fvk_test_...) is shown once.
curl -X POST https://api.finveil.money/api/api-keys \
  -H "Authorization: Bearer <ADMIN_ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Backend (test)", "environment": "TEST" }'

# 3. Create a payment link (amounts in cents). Send the buyer to the returned
#    paymentUrl, a Paystack hosted checkout running in test mode.
curl -X POST https://api.finveil.money/api/payment-links \
  -H "X-API-Key: fvk_test_<SECRET>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1001" \
  -d '{
    "amountCents": 14900,
    "currency": "ZAR",
    "description": "Order 1001",
    "provider": "PAYSTACK",
    "expiresInHours": 24
  }'

SDKs

SDKs are available on request.

We have SDK source code for the languages below, but none is published to a package registry yet, so there is nothing to install. Call the REST API directly, or ask us for an SDK.

Node.jsPythonJavaGoRustPHPC# / .NETKotlinFlutter / Dart