Artha API
  1. Funding
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Update Customer
      PATCH
  • Cards
    • Submit KYC/KYB Applicant
      POST
    • Issue Card
      POST
    • Cards List
      GET
    • Get Card
      GET
    • Get Sensitive Card Details
      GET
  • Card Operations
    • Activate Card
      POST
    • Freeze Card
      POST
    • Unfreeze Card
      POST
    • Cancel Card
      POST
    • Replace Card
      POST
    • Set / Reset Card PIN
      POST
    • Get Card Limits
      GET
    • Update Card Limits
      POST
  • Funding
    • Top Up Card
      POST
    • Get Card Balance
      GET
    • List Top-Up History
      GET
  • Transactions
    • List All Transactions
      GET
    • List Card Transactions
      GET
    • List Customer Transactions
      GET
    • Get Transaction
      GET
  • Products
    • List Products
    • Get Product
  • Utilities
    • Upload Documents
  • Webhook's
    • Webhooks
  1. Funding

Get Card Balance

GET
{{baseUrl}}/api/v1/cards/{cardId}/balance
Returns the current balance of a card.
Balance fields:
available_balance — funds available for new transactions (after holds)
hold_amount — funds temporarily reserved for pending authorizations
total_balance — gross balance including held funds (available + hold)

📤 Response Fields#

FieldTypeDescriptionNotes
card_idstring (uuid)--
available_balancenumberFunds available for transactions. Example: 450.0-
hold_amountnumberFunds reserved for pending authorizations. Example: 50.0-
total_balancenumberTotal balance including holds. Example: 500.0-
currencystring- Example: GBP-
retrieved_atstring (date-time)--

Request

Path Params

Header Params

Responses

🟢200
application/json
Balance retrieved.
Body

🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{baseUrl}}/api/v1/cards/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11/balance' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;'
Response Response Example
200 - Success
{
    "data": {
        "card_id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "available_balance": 450,
        "hold_amount": 50,
        "total_balance": 500,
        "currency": "GBP",
        "retrieved_at": "2024-01-15T10:30:00Z"
    }
}
Modified at 2026-02-18 13:25:16
Previous
Top Up Card
Next
List Top-Up History
Built with