Withdraw

Endpoint

POST /clients/business/customers/funds/withdraw

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

string

required

The customer account number to debit.

string

required

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

string

required

A description of the withdrawal.

Response

boolean

true on success.

string

Confirmation message.

string

Amount withdrawn, in kobo.

string

Fee charged for the withdrawal, in kobo.

string

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

Code examples

curl -X POST https://sandbox.stellasbank.com/api/v1/clients/business/customers/funds/withdraw \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "payerAccountNumber": "9012345678",
    "retrievalReference": "withdraw_ref_001",
    "narration": "ATM withdrawal"
  }'

const res = await fetch(
  "https://sandbox.stellasbank.com/api/v1/clients/business/customers/funds/withdraw",
  {
    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({
      payerAccountNumber: "9012345678",
      retrievalReference: "withdraw_ref_001",
      narration: "ATM withdrawal",
    }),
  }
);
const { data } = await res.json();

import requests

res = requests.post(
    "https://sandbox.stellasbank.com/api/v1/clients/business/customers/funds/withdraw",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    json={
        "payerAccountNumber": "9012345678",
        "retrievalReference": "withdraw_ref_001",
        "narration": "ATM withdrawal",
    },
)
print(res.json())

Example response

{
  "status": true,
  "message": "Withdrawal successful",
  "data": {
    "amount": "500000",
    "transactionCharge": "10000",
    "totalAmount": "510000"
  }
}

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

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