BillingPaymentsCrypto
BillingPaymentsCrypto
  • Getting Started
    • 👋 Welcome
    • 🔑 Sandbox credentials
    • 🏁 Getting Started
    • 📨 Webhooks
  • Payments API Reference
LogoLogo
Payments API ReferenceMerchant

GET
/api/v1/organizations/:organizationId/merchants/:merchantId/accounts/balances
GET
/api/v1/organizations/:organizationId/merchants/:merchantId/accounts/balances
1curl https://api.koywe.com/api/v1/organizations/organizationId/merchants/merchantId/accounts/balances \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1[
2  {
3    "id": "acc_6ead3cb5-e87f-4756-8389-8ad2f56757d0",
4    "accountNumber": "012342134123",
5    "currency": "USD",
6    "balance": "1000.50",
7    "balanceDate": "2024-07-01T22:40:22.003Z",
8    "address": "0x123...",
9    "network": "ethereum",
10    "merchantId": "mrc_31352afb-ce3a-4b7f-963d-b2512c646400",
11    "contactId": "con_31352afb-ce3a-4b7f-963d-b2512c646400"
12  }
13]
Was this page helpful?
Previous

Get balance for a specific merchant account

Next
Built with
Retrieves account balances for all bank accounts associated with a merchant, with optional filtering by currency and date.
Get balances for all merchant accounts

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

merchantIdstringRequired
Merchant ID
organizationIdstringRequired
Organization ID

Query parameters

currencyenumOptional
Filter balances by currency symbol (e.g. USD, ARS, CLP)
datestringOptionalformat: "date-time"
Date to get balances for. If not provided, returns the latest balances

Response

Get balances for all merchant accounts
idstring
accountNumberstring
The account number of the bank account
currencystring
The currency symbol of the account
balancestring
The current balance of the account
balanceDatestringformat: "date-time"
The date when the balance was requested. This could be the current date or a historical date if requesting past balances.
addressstring or null
The blockchain address for crypto accounts
networkstring or null
The blockchain network for crypto accounts
merchantIdstring or null
The merchant ID if this is a merchant account
contactIdstring or null
The contact ID if this is a contact account

Errors

Date to get balances for. If not provided, returns the latest balances
Get balances for all merchant accounts

Filter balances by currency symbol (e.g. USD, ARS, CLP)