Client Wallet API Documentation

This document explains how to retrieve your client account’s wallet balance information, including allocated and remaining limits.

Overview

The client/wallet endpoint provides real-time information about your client wallet’s balance. This is crucial for monitoring your available funds for payouts and other financial operations within the Swiftramp ecosystem.

Retrieve Wallet Details

Description: Fetches the current balance details for the authenticated client’s wallet.

Request Details

Endpoint: /client/wallet
Method: GET
Authentication: Bearer Token required.

cURL Command

curl --request GET \
  --url 'https://api.swiftramp.in/v1/client/wallet' \
  --header 'Authorization: Bearer [ACCESS_TOKEN]' \
  --header 'Content-Type: application/json'

Success Response (200 OK )

{
    "success": true,
    "message": "Wallet details fetched successfully",
    "data": {
        "allocated_balance": 5000000,
        "remaining_balance": 5000000
    }
}

Error Response (401 Unauthorized)

{
    "code": 401,
    "message": "Please authenticate"
}

Response Payload Details

Property Name	Type	Description
`success`	`boolean`	Indicates if the request was processed successfully.
`message`	`string`	A human-readable response message.
`data`	`object`	Contains the wallet balance details.
`data.allocated_balance`	`number`	The total credit limit or balance allocated to the client account.
`data.remaining_balance`	`number`	The current available balance for processing new transactions.

Important Notes

💡 Real-time Updates: Wallet balances are updated in real-time as transactions are processed or funds are added.
💡 Insufficient Funds: Ensure your remaining_balance is sufficient before initiating new payout transactions to avoid transaction failures.
💡 Currency: Unless otherwise specified, balances are represented in the default currency associated with your account (e.g., INR).
💡 Authorization: A valid Bearer token is required in the Authorization header for all requests.

Webhook Authentication: Configuration Your Keys