Main Resources
System
curl --request GET \
--url https://api.wellapp.ai/v1/balances \
--header 'Authorization: <authorization>'{
"data": [
{
"type": "balance",
"id": "balance1",
"attributes": {
"local_balance": {
"opening_booked": "123.32",
"opening_value": "124.42",
"closing_booked": "123.32",
"closing_value": "124.42",
"currency": "USD"
},
"accounting_balance": {
"opening_booked": "123.32",
"opening_value": "124.42",
"closing_booked": "123.32",
"closing_value": "124.42",
"currency": "EUR"
},
"foreign_exchange": [
{
"currency_rate": "1.2546",
"currency_pair": "EURUSD",
"currency_rate_source": "European Central Bank",
"currency_rate_at": "2025-06-01T14:30:00Z"
}
],
"balance_at_from": "2025-06-01T10:00:00Z",
"balance_at_to": "2025-06-03T10:00:00Z"
},
"relationships": {
"transactions": {
"data": [
{
"type": "transaction",
"id": "uuid1"
}
]
},
"account": {
"data": {
"type": "payment_mean",
"id": "uuid2"
}
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "workspace_tenant"
}
]
}
},
"included": {
"transaction": [
{
"type": "transaction",
"id": "uuid1",
"attributes": {
"scheme": "sepa",
"external_ids": {
"transaction_id": "TXN_SEPA_20250601_001",
"payment_request_id": "PAY_REQ_001",
"end_to_end_id": "E2E_20250601_ACME_001"
},
"requested_execution_date": "2025-06-01",
"executed_at": "2025-06-01T10:30:00Z",
"booking_date": "2025-06-01",
"value_date": "2025-06-01",
"instructed_amount": {
"currency": "EUR",
"amount": 50
},
"settlement_amount": {
"currency": "USD",
"amount": 54.25
},
"foreign_exchange": {
"currency_rate": "1.0850",
"currency_pair": "EURUSD",
"currency_rate_source": "European Central Bank",
"currency_rate_at": "2025-06-01T10:00:00Z"
},
"transaction_type": "transfer",
"status": "completed",
"category_purpose": "CBFF",
"purpose_code": "SALA",
"remittance_information": {
"unstructured": "Balance related transaction",
"structured_reference": "RF18539007547034",
"reference_type": "SCOR"
},
"fees": [
{
"type": "transfer_fee",
"amount": 1.5,
"currency": "EUR"
}
],
"created_at": "2025-06-01T10:30:00Z",
"updated_at": "2025-06-01T10:30:00Z"
}
}
],
"account": [
{
"type": "payment_means",
"id": "uuid2",
"attributes": {
"type": "account_details",
"scheme": "ACH",
"status": "active",
"account_details": {
"account_number": "1234567890",
"routing_number": "021000021",
"account_type": "checking",
"currency": "USD"
},
"bank_details": {
"bank_name": "JPMorgan Chase Bank, N.A.",
"bank_code": "CHASUS33",
"branch_name": "New York Main Branch",
"branch_code": "NY001"
},
"compliance": {
"kyc_status": "verified",
"aml_status": "cleared"
},
"nickname": "Main Operating Account",
"description": "Primary USD account for operations",
"tags": [
"usd",
"operating",
"primary"
],
"created_at": "2025-06-01T10:00:00Z",
"updated_at": "2025-06-01T10:00:00Z"
}
}
],
"workspaces": [
{
"type": "workspace",
"id": "workspace_tenant",
"attributes": {
"name": "Main Workspace",
"description": "Primary workspace for financial operations",
"created_at": "2025-06-01T08:00:00Z",
"updated_at": "2025-06-01T12:00:00Z",
"avatar_color": "#4A90E2",
"external_workspace_id": "workspace-001",
"auto_extract_enabled": true
}
}
]
},
"meta": {
"total": 25,
"page": 1,
"per_page": 20,
"total_pages": 2
}
}
]
}Get Balance
Retrieve a paginated list of balance records with advanced filtering, sorting, and relationship inclusion capabilities. Supports filtering by date ranges, account relationships, workspace associations, and currency information.
curl --request GET \
--url https://api.wellapp.ai/v1/balances \
--header 'Authorization: <authorization>'{
"data": [
{
"type": "balance",
"id": "balance1",
"attributes": {
"local_balance": {
"opening_booked": "123.32",
"opening_value": "124.42",
"closing_booked": "123.32",
"closing_value": "124.42",
"currency": "USD"
},
"accounting_balance": {
"opening_booked": "123.32",
"opening_value": "124.42",
"closing_booked": "123.32",
"closing_value": "124.42",
"currency": "EUR"
},
"foreign_exchange": [
{
"currency_rate": "1.2546",
"currency_pair": "EURUSD",
"currency_rate_source": "European Central Bank",
"currency_rate_at": "2025-06-01T14:30:00Z"
}
],
"balance_at_from": "2025-06-01T10:00:00Z",
"balance_at_to": "2025-06-03T10:00:00Z"
},
"relationships": {
"transactions": {
"data": [
{
"type": "transaction",
"id": "uuid1"
}
]
},
"account": {
"data": {
"type": "payment_mean",
"id": "uuid2"
}
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "workspace_tenant"
}
]
}
},
"included": {
"transaction": [
{
"type": "transaction",
"id": "uuid1",
"attributes": {
"scheme": "sepa",
"external_ids": {
"transaction_id": "TXN_SEPA_20250601_001",
"payment_request_id": "PAY_REQ_001",
"end_to_end_id": "E2E_20250601_ACME_001"
},
"requested_execution_date": "2025-06-01",
"executed_at": "2025-06-01T10:30:00Z",
"booking_date": "2025-06-01",
"value_date": "2025-06-01",
"instructed_amount": {
"currency": "EUR",
"amount": 50
},
"settlement_amount": {
"currency": "USD",
"amount": 54.25
},
"foreign_exchange": {
"currency_rate": "1.0850",
"currency_pair": "EURUSD",
"currency_rate_source": "European Central Bank",
"currency_rate_at": "2025-06-01T10:00:00Z"
},
"transaction_type": "transfer",
"status": "completed",
"category_purpose": "CBFF",
"purpose_code": "SALA",
"remittance_information": {
"unstructured": "Balance related transaction",
"structured_reference": "RF18539007547034",
"reference_type": "SCOR"
},
"fees": [
{
"type": "transfer_fee",
"amount": 1.5,
"currency": "EUR"
}
],
"created_at": "2025-06-01T10:30:00Z",
"updated_at": "2025-06-01T10:30:00Z"
}
}
],
"account": [
{
"type": "payment_means",
"id": "uuid2",
"attributes": {
"type": "account_details",
"scheme": "ACH",
"status": "active",
"account_details": {
"account_number": "1234567890",
"routing_number": "021000021",
"account_type": "checking",
"currency": "USD"
},
"bank_details": {
"bank_name": "JPMorgan Chase Bank, N.A.",
"bank_code": "CHASUS33",
"branch_name": "New York Main Branch",
"branch_code": "NY001"
},
"compliance": {
"kyc_status": "verified",
"aml_status": "cleared"
},
"nickname": "Main Operating Account",
"description": "Primary USD account for operations",
"tags": [
"usd",
"operating",
"primary"
],
"created_at": "2025-06-01T10:00:00Z",
"updated_at": "2025-06-01T10:00:00Z"
}
}
],
"workspaces": [
{
"type": "workspace",
"id": "workspace_tenant",
"attributes": {
"name": "Main Workspace",
"description": "Primary workspace for financial operations",
"created_at": "2025-06-01T08:00:00Z",
"updated_at": "2025-06-01T12:00:00Z",
"avatar_color": "#4A90E2",
"external_workspace_id": "workspace-001",
"auto_extract_enabled": true
}
}
]
},
"meta": {
"total": 25,
"page": 1,
"per_page": 20,
"total_pages": 2
}
}
]
}Headers
Bearer token for authentication
Query Parameters
Include detailed relationship data in the response. Comma-separated values supported.
transactions, account, workspaces Filter balances with balance_at_from on or after this date/time
Filter balances with balance_at_from on or before this date/time
Filter balances with balance_at_to on or after this date/time
Filter balances with balance_at_to on or before this date/time
Filter balances created from this date/time
Filter balances created up to this date/time
Filter balances updated from this date/time
Filter balances updated up to this date/time
Filter balances by account ID (payment mean)
Filter balances by workspace ID
Filter balances by external workspace ID
Sort balances by field. Use - prefix for descending order.
balance_at_from, -balance_at_from, balance_at_to, -balance_at_to, created_at, -created_at, updated_at, -updated_at Page number for pagination
x >= 1Number of balances per page
1 <= x <= 100Response
Balance records retrieved successfully
Show child attributes
Show child attributes
Show child attributes
Show child attributes
balance Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Resource type identifier
"transaction"Unique identifier for the transaction
Show child attributes
Show child attributes
Payment scheme used for the transaction
sepa, swift, ach, faster_payments, instant_credit_transfer Show child attributes
Show child attributes
External transaction identifier from payment provider
Payment request identifier
End-to-end reference for tracing the transaction
Date when transaction execution was requested
Timestamp when transaction was executed
Date when transaction was booked
Value date of the transaction
Show child attributes
Show child attributes
Exchange rate applied
Currency pair (e.g., EURUSD)
Source of the exchange rate
Timestamp when exchange rate was applied
Type of transaction
transfer, direct_debit, card_payment, standing_order, fee Current status of the transaction
pending, completed, failed, cancelled, rejected ISO 20022 category purpose code
ISO 20022 purpose code
Show child attributes
Show child attributes
Unstructured remittance information
Structured creditor reference
Type of structured reference
SCOR, RADM, RPIN, FXDR, DISP, PUOR, SCNR Show child attributes
Show child attributes
Type of fee
transfer_fee, exchange_fee, processing_fee, commission Fee amount
x >= 0ISO 4217 currency code
Timestamp when transaction was created
Timestamp when transaction was last updated
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Resource type identifier
"payment_means"Unique identifier for the payment means
Show child attributes
Show child attributes
Type of payment means
account_details, card_details, wallet_details Current status of payment means
pending, active, inactive, suspended, expired, blocked Show child attributes
Show child attributes
International Bank Account Number
Bank Identifier Code
Local account number
50UK bank sort code
US bank routing number
Account base currency (ISO 4217)
Show child attributes
Show child attributes
Masked card number
Card brand
visa, mastercard, amex, discover, diners, jcb, unionpay Card type
credit, debit, prepaid, corporate, virtual Card expiry month
1 <= x <= 12Card expiry year
x >= 2025Name on card
100Show child attributes
Show child attributes
Wallet provider
paypal, apple_pay, google_pay, samsung_pay, alipay, wechat_pay Wallet identifier
255Type of wallet account
personal, business, merchant Show child attributes
Show child attributes
Full bank name
255Bank identifier code
20Branch name
255Branch identifier
20Show child attributes
Show child attributes
Show child attributes
Show child attributes
KYC verification status
pending, in_progress, completed, failed, expired AML check status
pending, cleared, flagged, blocked Sanctions screening result
pending, passed, flagged, blocked Last compliance verification timestamp
User-friendly name
100Additional description
500Custom tags for categorization
Creation timestamp
Last update timestamp
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"workspace"Show child attributes
Show child attributes