GET Merchant Balance

Retrieve current merchant information and status

GET /merchant/balance

Get Merchant Information

cURL

curl --request GET \
  --url https://api-empresas.staging.tumipay.co/production/api/v1/merchant/balance \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Token-Top: <api-key>'

{
    "code": "01",
    "status": "SUCCESS",
    "message": "",
    "data": {
        "currency": "COP",
        "balance": 138827007.4,
        "balance_formatted": "COP 138.827.007,40"
    }
}

Retrieves the current balance information for the authenticated merchant account. This endpoint provides the merchant’s wallet balance in both raw numeric format and formatted currency display.

cURL

shellscript

curl --location 'https://api-empresas.staging.tumipay.co/production/api/v1/merchant/balance' \
--header 'Token-Top: your_auth_token' \
--header 'Authorization: Basic your_auth_key'

{
    "code": "01",
    "status": "SUCCESS",
    "message": "",
    "data": {
        "currency": "COP",
        "balance": 138827007.4,
        "balance_formatted": "COP 138.827.007,40"
    }
}

Required Headers

Token-Top · string · required

Your merchant authentication token

Authorization · string · required

Basic authentication credentials

Response

code · string

Response code indicating success or failure

status · string

Status of the response (e.g., “SUCCESS”)

message · string

Additional message about the response

data · object

Show Balance Information

currency · string

The currency code for the balance (e.g., “COP”)

balance · number

Current wallet balance in raw numeric format

balance_formatted · string

Human-readable formatted balance with currency symbol and thousands separators

Authorizations

Token-Top · string · header · required

Merchant authentication token

Authorization · string · header · required

Basic authentication with username and password

Response

200

application/json

Successful response

id · string<uuid>

Unique identifier for the merchant

name · string

Commercial name of the merchant

legal_name · string

Legal registered name of the business

document_number · string

Tax ID or business registration number

business_type · enum<string>

Type of business

Available options: COMPANY, INDIVIDUAL

status · enum<string>

Current merchant status

Available options: ACTIVE, INACTIVE, PENDING

email · string<email>

Primary contact email

phone · string

Contact phone number with country code

country · string

Two-letter country code (ISO 3166-1 alpha-2)

created_at · string<date-time>

UTC timestamp of merchant account creation

updated_at · string<date-time>

UTC timestamp of last account update