Developers

Getting Started

Create an account in TEST mode, mint a test API key and take a test payment. No real money moves.

1. 1

   Create your account

   Sign up for a free FinVeil account. It starts on the Sandbox plan in TEST mode, on the same API (https://api.finveil.money) you will use live.

   Create account
2. 2

   Get a test API key

   As the account ADMIN, open the API Keys page and mint a TEST key. It looks like fvk_test_… and is shown once, so store it server-side.

   API Keys settings
3. 3

   Call the REST API

   There is no published SDK to install yet. Send the key as an X-API-Key header on plain HTTPS requests.

   About SDKs
4. 4

   Create a test payment link

   POST /api/payment-links with amountCents, currency "ZAR" and provider "PAYSTACK". Open the returned paymentUrl (a Paystack test checkout), pay with Paystack test card 4084 0840 8408 4081, then poll GET /api/payments/by-reference/{reference}/status until it reads SUCCEEDED.

   API Reference