Getting Started
Quick Start Guide
Step 1: Get Your API Key
Production API Key
- Log in to your Esca Dashboard
- Click Developer in the sidebar
- In the API Keys tab, click Create API Key
- Enter a name for your API key and click Create
- Copy and securely store your API key (it will only be shown once)
Sandbox API Key
To test the API in a sandbox environment:
- Register for a sandbox account (if you don't have one)
- Log in to the Sandbox Dashboard
- Click Developer in the sidebar
- In the API Keys tab, click Create API Key
- Enter a name for your API key and click Create
- Copy and securely store your sandbox API key
Step 2: Make Your First API Call
Test your API key by fetching the list of supported banks:
curl -X GET "https://sandbox.api.esca.finance/v1/virtual-account/banks?country=NG" \
-H "X-Api-Key: your_api_key_here"
Step 3: Create a Virtual Account
curl -X POST "https://sandbox.api.esca.finance/v1/virtual-account" \
-H "X-Api-Key: your_api_key_here" \
-H "X-Idempotency-Key: unique-request-id-123" \
-H "Content-Type: application/json" \
-d '{
"currency": "NGN",
"email": "customer@example.com"
}'
Step 4: Set Up Webhooks
Configure webhook endpoints in the Developer > Webhooks tab to receive real-time notifications for:
- Deposits received
- Transfer completions
- Transfer failures