Artha All Module Api's
    • Introduction
    • Authentication
    • KYC/KYB Requirements
    • API Setup Guide
    • Products
      • List Products
        GET
      • Get Product
        GET
      • Get Customer Product Status
        GET
    • Customers
      • Create Customer
        POST
      • List Customers
        GET
      • Get Customer
        GET
      • Submit Applicant (KYC/KYB)
        POST
      • Create Onboarding Session
        POST
    • Wallets
      • Beneficiary
        • Create Crypto Beneficiary
        • Update Crypto Beneficiary
        • List Crypto Withdraw Beneficiaries
      • Create Wallet
        POST
      • Get Wallet Address
        GET
      • Get Customer Balances
        GET
      • List Wallets
        GET
      • List Withdrawals
        GET
      • List Withdrawal Networks
        GET
      • Preview Withdrawal Summary
        POST
      • Create Crypto Withdrawal
        POST
    • Cards
      • Issuance
        • Issue Card
        • List Cards
        • List Customer Cards
        • Get Card Details
        • Get Sensitive Card Details
      • Funding
        • Top Up Card
        • Get Card Balance
        • Get Top-Up Status
        • List Top-Up History
      • Operations
        • Resend Activation Code
        • Activate Card
        • Set Card PIN
        • Change Card PIN
        • Update Card Limits
        • Freeze Card
        • Unfreeze Card
        • Replace Card
        • Cancel Card
        • Get Card Limits
        • Show Card PIN Details
        • Get PIN View Iframe URL
        • Get PIN Change Iframe URL
        • Get PIN Set Iframe URL
        • Get Card View Iframe URL
        • Show Card PIN
    • Payees
      • Create a payee for a customer.
        POST
      • List a customer's payees.
        GET
      • Update a payee.
        PUT
      • Retrieve a payee by id.
        GET
      • Look up an existing payee.
        GET
      • List the currencies a payee can be created in.
        GET
      • List the accepted payment purpose codes for a payee.
        GET
      • List the countries a payee can be created in.
        GET
      • List currency/country pairings for payees.
        GET
      • List the accepted beneficiary relationship codes.
        GET
    • Payments
      • Onboarding
        • List the customer's payout-currency configuration sections.
        • Enable a payout-currency section for the customer.
        • Get the customer's terms-of-service acceptance status.
        • Enable or disable a payout-currency section.
      • Quote
        • List the currencies a beneficiary can be paid in under a product.
        • List the payout rails available for a product and beneficiary.
        • Create an FX quote giving the rate and fee for a cross-currency payout.
      • Order
        • Submit a payout order to send money to a beneficiary.
        • Retrieve the on-chain address to fund an order.
        • Retrieve the status and settlement detail of a payout order.
      • Lookups
        • List the accepted payment purpose codes for a payout.
        • List the accepted source-of-funds codes for a payout.
        • List the document types accepted on a payout order.
    • Banks
      • Accounts
        • Create Bank Account
        • Get Account Details
        • Get Account Issuance Status
      • Withdraw
        • Create Withdrawal Quote
        • List Withdrawal Purposes
        • Get Payment Schemes
        • Execute Withdrawal
    • Exchange
      • Quote
        • Get Exchange Rate
        • Create Price Quote
      • Order
        • Place Exchange Order
    • Transactions
      • List Transactions
      • Get Transaction Details
    • Utilities
      • List Currencies
      • List Countries
      • Get Fee Schedule
      • List Product Occupations
      • List Product Industry Codes
      • Upload File
    • Webhook's
      • Wallets Webhooks
      • Banks Webhooks
      • Payments Webhooks
      • Exchange Webhooks
      • Card 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://tstapi.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://tstapi.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://tstapi.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://tstapi.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-09-23 05:21:46
    Previous
    KYC/KYB Requirements
    Next
    List Products
    Built with