Skip to main content

​
Get Pool Balance

GET /pool/balance Returns the current USDC balance and status of your company’s treasury pool.

​
Authentication

Requires a Secret Key (sk_...) in the x-api-key header or Bearer token.

​
Response Fields

FieldTypeDescription
balancestringTotal USDC available in the treasury pool.
currencystringAlways USDC.
low_thresholdstringConfigured balance below which a “low balance” alert is triggered.
is_lowbooleantrue if current balance is below the threshold.
remaining_before_alertstringAmount that can be spent before hitting the threshold.
auto_top_up_enabledbooleanIndicates if automatic funding from a bank/wallet is enabled.

​
Sample Response

{
  "balance": "4950.00",
  "currency": "USDC",
  "low_threshold": "1000.00",
  "is_low": false,
  "remaining_before_alert": "3950.00",
  "auto_top_up_enabled": false
}

​
List Pool Transactions

GET /pool/transactions Retrieve historical movements in your pool, including deposits, payments (debits), and withdrawals.

​
Query Parameters

ParameterTypeDefaultDescription
typestring-Filter by: DEPOSIT, DEBIT (payment), CREDIT (refund), WITHDRAWAL.
limitnumber50Results per page (max 100).
offsetnumber0Number of results to skip.

​
Response Fields

FieldTypeDescription
transactionsarrayList of transaction objects.
paginationobjectMetadata including total count and has_more flag.

​
Transaction Object

FieldTypeDescription
idstringInternal transaction ID.
typestringType of movement (e.g., DEBIT).
amountstringAmount changed (negative for debits/withdrawals).
balance_beforestringPool balance before this transaction.
balance_afterstringPool balance after this transaction.
statusstringStatus: PENDING or CONFIRMED.
tx_hashstringBlockchain transaction hash (if applicable).
descriptionstringHuman-readable explanation.
paymentobjectReference to the associated payment (only for DEBIT and CREDIT).
created_atstringISO 8601 timestamp.
confirmed_atstringTime of transaction finality.

​
Sample Response

{
  "transactions": [
    {
      "id": "ptx_abc123",
      "type": "DEBIT",
      "amount": "-15.00",
      "balance_before": "5000.00",
      "balance_after": "4985.00",
      "status": "CONFIRMED",
      "tx_hash": "0xabcd...",
      "description": "Payment for Merchant: Organic Coffee",
      "payment": {
        "payment_id": "pay_999",
        "amount": "15.00",
        "merchant_name": "Organic Coffee"
      },
      "created_at": "2026-03-31T01:50:00Z",
      "confirmed_at": "2026-03-31T01:50:05Z"
    }
  ],
  "pagination": {
    "total": 542,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}