Virtual account transfer

Endpoint

POST /clients/business/virtual-accounts/transfer

Headers

string

required

Your public API key.

string

required

Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.

string

required

Your business ID.

Request body

integer

required

Amount to transfer, in kobo. For example, 110000 equals ₦1,100.

string

required

The virtual account number to debit (the source of funds).

string

required

The destination bank account number to credit.

string

required

The bank code of the receiving bank. Use the billers list from Get billers to look up codes.

string

required

A unique reference you generate for this transaction. Used for idempotency and reconciliation.

string

required

A description of the transfer, visible to both parties.

Response

boolean

true on success.

string

Confirmation message, e.g. "Transfer successful".

string

Amount transferred, in kobo.

string

Fee charged for the transfer, in kobo.

string

Total amount debited from the payer account (amount + charge), in kobo.

Code examples

curl -X POST https://sandbox.stellasbank.com/api/v1/clients/business/virtual-accounts/transfer \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 110000,
    "payerAccountNumber": "9012345678",
    "receiverAccountNumber": "0123456789",
    "receiverBankCode": "044",
    "retrievalReference": "txn_ref_001",
    "narration": "Payment for services"
  }'

const res = await fetch(
  "https://sandbox.stellasbank.com/api/v1/clients/business/virtual-accounts/transfer",
  {
    method: "POST",
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      amount: 110000,
      payerAccountNumber: "9012345678",
      receiverAccountNumber: "0123456789",
      receiverBankCode: "044",
      retrievalReference: "txn_ref_001",
      narration: "Payment for services",
    }),
  }
);
const { data } = await res.json();

import requests

res = requests.post(
    "https://sandbox.stellasbank.com/api/v1/clients/business/virtual-accounts/transfer",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    json={
        "amount": 110000,
        "payerAccountNumber": "9012345678",
        "receiverAccountNumber": "0123456789",
        "receiverBankCode": "044",
        "retrievalReference": "txn_ref_001",
        "narration": "Payment for services",
    },
)
print(res.json())

Example response

{
  "status": true,
  "message": "Transfer successful",
  "data": {
    "amount": "110000",
    "transactionCharge": "10000",
    "totalAmount": "120000"
  }
}

All amounts are in kobo. Divide by 100 to convert to naira.

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Virtual account transfer

Endpoint

Headers

Request body

Response

Code examples

Example response

​Endpoint

​Headers

​Request body

​Response

​Code examples

​Example response

Endpoint

Headers

Request body

Response

Code examples

Example response