# Wallet

# Introduction

The Wallet API allows you to fetch the merchant's current wallet data at any time. This is useful for displaying balance information in your application or monitoring wallet status proactively.

# Get Wallet

To get the merchant's wallet information, you will need to make an HTTP GET request to the following endpoint:

GET
https://api.armadadelivery.com/v1/wallet

Required Permission: wallet:read

# Request Example

Remember to include your Armada-Access-Token in the request headers. If you don't have one, please refer to the Authentication page to learn how to obtain it.

cURL
curl --location --request GET 'https://api.armadadelivery.com/v1/wallet' \
--header 'Armada-Access-Token: [YOUR ACCESS TOKEN]'

# Response Schema

{
  "balance": Number, // Current wallet balance
  "warning_balance_level": Number, // Low balance threshold configured by the merchant
  "currency": "String" // Currency code (KWD, BHD, SAR)
}

# Response Example

{
  "balance": 1,
  "warning_balance_level": 5,
  "currency": "KWD"
}

# Use Cases

Show real-time wallet balance in your merchant dashboard to keep them informed about their account status.

Check wallet balance before creating orders to ensure sufficient funds and prevent order failures.

Implement custom alert logic to notify merchants when balance is below certain thresholds.

Include wallet balance data in financial reports and analytics dashboards.

wallet.balance_low Webhook - Receive automatic notifications when balance reaches the warning threshold