EscaGuideAPI Reference

Bulk Transfer

Process multiple transfers in a single API call. Maximum 100 transfers per request.

POST /v1/virtual-account/bulk-transfer

Headers

Header Required Description
X-Api-Key Yes Your API key
X-Idempotency-Key Yes Unique key to prevent duplicate batch submissions
Content-Type Yes application/json

Request Body

Field Type Required Description
transfers array Yes Array of transfer objects (max 100)

Transfer Object

Field Type Required Description
currency string Yes Currency: NGN or GHS
accountId integer Yes Source virtual account ID
amount number Yes Amount to transfer
destinationBankCode string Yes Destination bank code
destinationAccountNumber string Yes Destination account number
destinationAccountName string Yes Destination account name
description string No Transfer description
externalReference string No Your reference for tracking

Example Request 

curl -X POST "https://api.esca.finance/v1/virtual-account/bulk-transfer" \
  -H "X-Api-Key: your_api_key_here" \
  -H "X-Idempotency-Key: bulk-550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{
    "transfers": [
      {
        "currency": "NGN",
        "accountId": 12345,
        "amount": 10000,
        "destinationBankCode": "000007",
        "destinationAccountNumber": "0123456789",
        "destinationAccountName": "JOHN DOE",
        "description": "Salary payment",
        "externalReference": "SAL-001"
      },
      {
        "currency": "NGN",
        "accountId": 12345,
        "amount": 15000,
        "destinationBankCode": "058",
        "destinationAccountNumber": "9876543210",
        "destinationAccountName": "JANE SMITH",
        "description": "Salary payment",
        "externalReference": "SAL-002"
      }
    ]
  }'

Example Response 

{
  "status": true,
  "data": {
    "batchId": "api-1705574400000-12345",
    "transferCount": 2
  }
}