Artha API
    • 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

    API Setup Guide

    Before You Start — Set Your Base URL#

    All API endpoints in this documentation use a variable called {{baseUrl}} as a placeholder for the server address. You must set this variable once before running any API call.
    EnvironmentBase URL
    Test (TST)https://tstcardsapi.artha.money
    Production (PRD)To be configured — contact your administrator

    Step-by-Step: Setting the Base URL#

    Step 1 — Open the Products Endpoint#

    Click on the Products endpoint from the left sidebar.

    Step 2 — Click on {{baseUrl}}#

    In the request URL bar at the top, you will see the URL prefixed with {{baseUrl}}, like this:
    GET   {{baseUrl}} /api/v1/Products
    Click directly on the {{baseUrl}} text in the URL bar. A Personal Variables popup will appear.

    Step 3 — Set the Value#

    In the Personal Variables dialog:
    1.
    You will see a variable named baseUrl already listed.
    2.
    Click the empty Value field next to baseUrl.
    3.
    Enter the environment URL you want to test against:
    For TST:
    https://tstcardsapi.artha.money
    For PRD (once available):
    To be configured — contact your administrator
    4.
    Click Save & Exit.
    💡 These values are stored locally in your browser and will not be synced to the cloud. You will need to set this once per browser/device. To switch environments, simply repeat this step with the new URL.

    Step 4 — Run the API#

    Once the base URL is set, click the ▶ Run button (play button on the right side of the URL bar) to execute the request.
    The full resolved URL will look like:
    TST:
    GET https://tstcardsapi.artha.money/api/v1/Products
    PRD:
    To be configured — contact your administrator

    Switching Between TST and PRD#

    To switch environments, just update the {{baseUrl}} value:
    1.
    Click {{baseUrl}} in the Products endpoint URL bar.
    2.
    Clear the current value and enter the new environment URL.
    3.
    Click Save & Exit.
    4.
    All endpoints will now resolve against the new base URL automatically.
    ✅ Tip — Use GET {{baseUrl}}/api/v1/Products as a quick sanity check after switching environments. A successful 200 OK response confirms your base URL is correctly set.
    ⚠️ Production Caution — Always confirm you intend to run against PRD before switching. API calls in production affect live data.

    Environment Summary#

    EnvironmentVariableValue
    Test{{baseUrl}}https://tstcardsapi.artha.money
    Production{{baseUrl}}To be configured — contact your administrator

    Quick Checklist#

    Before running any API, confirm the following:
    {{baseUrl}} is set to the correct environment URL
    Open the Products endpoint — GET {{baseUrl}}/api/v1/Products
    Click the ▶ Run button — a 200 OK response confirms your setup is working
    You can now proceed to run any other endpoint

    Troubleshooting#

    IssueFix
    URL still shows {{baseUrl}} unresolvedRe-open the variable dialog, ensure the value is saved and not empty
    401 UnauthorizedConfirm your credentials or token are correct in the request headers
    404 Not FoundDouble-check path parameters like {customerId} are replaced with actual IDs
    Connection refused / timeoutConfirm you are on the correct network and the server is reachable
    Accidentally ran on PRDContact your administrator immediately to review the affected records

    Modified at 2026-02-18 17:31:55
    Previous
    KYC/KYB Requirements
    Next
    Create Customer
    Built with