Skip to main content

​
Endpoint

POST /clients/business/customers/funds/withdraw

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
Your business ID.

​
Request body

​
payerAccountNumber
string
required
The customer account number to debit.
​
retrievalReference
string
required
A unique reference you generate for this withdrawal. Used for idempotency and reconciliation.
​
narration
string
required
A description of the withdrawal.

​
Response

​
status
boolean
true on success.
​
message
string
Confirmation message.
​
data.amount
string
Amount withdrawn, in kobo.
​
data.transactionCharge
string
Fee charged for the withdrawal, in kobo.
​
data.totalAmount
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 "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "payerAccountNumber": "9012345678",
    "retrievalReference": "withdraw_ref_001",
    "narration": "ATM withdrawal"
  }'

​
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.