Retrieve Wallet Balance for Business

GET /api/v1/transfers/business/{businessId}/wallet/{walletUuid}/balance

Description

Retrieves the current balance of a specified wallet for a business. This endpoint is used to check financial details such as available funds, which is crucial for managing business operations and financial planning.

URL Parameters:

• businessId (required): The unique identifier of the business whose wallet balance is being queried. This must be included in the URL path.
• walletUuid (required): The unique identifier of the wallet whose balance is being queried. This must also be included in the URL path.

Headers:

• tenantId (required): The tenant ID associated with the request, indicating under which tenant the wallet is registered. This should be included as a header.
• countryCode (optional): The country code where the business is located, helping to categorize the request by geographical location.
• userId (optional): The user ID of the individual querying the wallet balance. Including this can help in tracking who made the query.

Example Request:

curl -G "http://[base_url]/api/v1/transfers/business/{businessId}/wallet/{walletUuid}/balance" \
     -H "Authorization: Bearer [access_token]" \
     -H "tenantId: TEN123" \
     -H "countryCode: US" \
     -H "userId: USR456"

Responses:

• 200 OK: Successfully retrieved the wallet balance. The response includes detailed information about the current funds available in the wallet.

Example Response:

{
  "balance": "15000.00",
  "currency": "USD",
  "lastUpdated": "2023-01-15T12:00:00Z"
}

Error Responses:

• 400 Bad Request: Incorrect request parameters or headers.
• 404 Not Found: No wallet or business found with the provided identifiers.
• 403 Forbidden: The user does not have permission to view the wallet balance.