MPChatMPChat/Docs

Balance & Ledger

Your merchant balance tracks USDT credited from confirmed payments minus withdrawals and fees. The ledger provides an append-only double-entry record of every credit and debit.

The Balance object

FieldTypeDescription
merchant_idstringYour merchant UUID
availablestringUSDT available for withdrawal
frozenstringUSDT held pending withdrawal processing

Retrieve balance

GET
/v1/balance

Get your current available and frozen USDT balance

ℹ️available is the amount you can withdraw now. frozen is held while a withdrawal is being processed and will be released if the withdrawal fails.

Returns Returns the Balance object.

Request

bash
curl https://api.mpchat.com/v1/balance \
  -H "Authorization: Bearer mk_live_abc:{ts}:{sig}"

Response 200

JSON
{
  "merchant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "available": "1250.50",
  "frozen": "500.00"
}

List transactions (ledger)

GET
/v1/transactions

Return a paginated list of ledger entries (credits and debits)

Query parameters

limitintegeroptionaldefault: 20

Maximum entries to return. Max 100.

offsetintegeroptionaldefault: 0

Number of entries to skip.

Returns Returns an object with a transactions array and total count. Entries are returned newest-first.

Request

bash
curl "https://api.mpchat.com/v1/transactions?limit=20&offset=0" \
  -H "Authorization: Bearer mk_live_abc:{ts}:{sig}"

Response 200

JSON
{
  "transactions": [
    {
      "id": "e5f6a7b8-c9d0-1234-efab-567890123456",
      "merchant_id": "a1b2c3d4-...",
      "order_id": "c3d4e5f6-...",
      "entry_type": "CREDIT",
      "amount": "98.99",
      "balance_after": "1250.50",
      "description": "Payment received for ord_6f8a2b",
      "created_at": "2024-01-15T10:05:12Z"
    },
    {
      "id": "f6a7b8c9-d0e1-2345-fabc-678901234567",
      "merchant_id": "a1b2c3d4-...",
      "order_id": null,
      "entry_type": "DEBIT",
      "amount": "500.00",
      "balance_after": "750.50",
      "description": "Withdrawal wd_01HQ8ZTXV...",
      "created_at": "2024-01-15T14:30:00Z"
    }
  ],
  "total": 28
}

Next: Merchants & Keys API