BalanceStatement
A balance statement.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
GET |
/profiles/{profileId}/balance-statements/{balanceId}/statement.json |
load |
OK - Successfully retrieved balance statement |
Examples
One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.
Golang
Construct client as shown in the Golang setup, then call the operations:
balance_statement, err := client.BalanceStatement(nil).Load(map[string]any{"id": 1, "profile_id": 1, "currency": "example", "interval_end": "example", "interval_start": "example"}, nil)
if err != nil {
panic(err)
}
fmt.Println(balance_statement)
Lua
Construct client as shown in the Lua setup, then call the operations:
local balance_statement, err = client:BalanceStatement():load({ id = 1, profile_id = 1, currency = "example", interval_end = "example", interval_start = "example" })
PHP
Construct client as shown in the PHP setup, then call the operations:
$balance_statement = $client->BalanceStatement()->load(["id" => 1, "profile_id" => 1, "currency" => "example", "interval_end" => "example", "interval_start" => "example"]);
Python
Construct client as shown in the Python setup, then call the operations:
balance_statement = client.BalanceStatement().load({"id": 1, "profile_id": 1, "currency": "example", "interval_end": "example", "interval_start": "example"})
Ruby
Construct client as shown in the Ruby setup, then call the operations:
balance_statement = client.BalanceStatement.load({ "id" => 1, "profile_id" => 1, "currency" => "example", "interval_end" => "example", "interval_start" => "example" })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const balance_statement = await client.BalanceStatement().load({ id: 1, profile_id: 1, currency: "example", interval_end: "example", interval_start: "example" })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
accountHolder |
object |
No | Account holder information. |
bankDetails |
one,object,null |
No | Local bank details for the account. |
endOfStatementBalance |
object |
No | Closing balance for the specified time period. |
id |
string |
No | Id |
issuer |
object |
No | Account issuer information. |
query |
object |
No | Query parameters used for the request. |
transactions |
array |
No | List of transactions in the statement period. |
load
GET /profiles/{profileId}/balance-statements/{balanceId}/statement.json
Operation ID: balanceStatementGet.
Authentication: bearer token (UserToken) or bearer token (PersonalToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | The profile ID. |
balanceId |
path |
integer (int64) |
Yes | The balance ID to get the statement for. |
currency |
query |
string |
Yes | Currency of the balance statement requested (ISO 4217 Alphabetic Code). |
intervalStart |
query |
string (date-time) |
Yes | Statement start time in UTC. |
intervalEnd |
query |
string (date-time) |
Yes | Statement end time in UTC. |
type |
query |
enum: COMPACT, FLAT |
No | Statement type: - COMPACT - Single statement line per transaction - FLAT - Accounting statements where transaction fees are on a separate line |
statementLocale |
query |
string |
No | Language for the statement. Supports 2 character language codes. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: OK - Successfully retrieved balance statement
application/json
| Property | Type | Required | Description |
|---|---|---|---|
accountHolder |
object |
No | Account holder information. |
accountHolder.address |
object |
No | Account holder address. |
accountHolder.address.addressFirstLine |
string |
No | Street address. |
accountHolder.address.city |
string |
No | City. |
accountHolder.address.countryName |
string |
No | Country name. |
accountHolder.address.postCode |
string |
No | Postal/ZIP code. |
accountHolder.address.stateCode |
string |
No | State code. |
accountHolder.firstName |
string |
No | Account holder first name. |
accountHolder.lastName |
string |
No | Account holder last name. |
accountHolder.type |
enum: PERSONAL, BUSINESS |
No | Account holder type. |
bankDetails |
object,null |
No | Local bank details for the account. |
endOfStatementBalance |
object |
No | Closing balance for the specified time period. |
endOfStatementBalance.currency |
string |
No | Currency code. |
endOfStatementBalance.value |
number |
No | Balance value. |
issuer |
object |
No | Account issuer information. |
issuer.city |
string |
No | City. |
issuer.country |
string |
No | Country. |
issuer.firstLine |
string |
No | Street address. |
issuer.name |
string |
No | Issuer name. |
issuer.postCode |
string |
No | Postal/ZIP code. |
issuer.stateCode |
string |
No | State code. |
query |
object |
No | Query parameters used for the request. |
query.accountId |
integer (int64) |
No | Balance account ID. |
query.currency |
string |
No | Currency code. |
query.intervalEnd |
string (date-time) |
No | Statement end time. |
query.intervalStart |
string (date-time) |
No | Statement start time. |
transactions |
array of object |
No | List of transactions in the statement period. |
transactions[].amount |
object |
No | Transaction amount. |
transactions[].amount.currency |
string |
No | Currency code. |
transactions[].amount.value |
number |
No | Amount value (negative for debits). |
transactions[].date |
string (date-time) |
No | Date when transaction was created. |
transactions[].details |
object |
No | Transaction details. |
transactions[].details.amount |
object |
No | Amount in original currency (for card transactions abroad). |
transactions[].details.amount.currency |
string |
No | |
transactions[].details.amount.value |
number |
No | |
transactions[].details.category |
string |
No | Card transaction category. |
transactions[].details.description |
string |
No | Human readable explanation about the transaction. |
transactions[].details.fee |
object |
No | Conversion fee. |
transactions[].details.fee.currency |
string |
No | |
transactions[].details.fee.value |
number |
No | |
transactions[].details.merchant |
object |
No | Card transaction merchant details. |
transactions[].details.merchant.category |
string |
No | Merchant category. |
transactions[].details.merchant.city |
string |
No | Merchant address city. |
transactions[].details.merchant.country |
string |
No | Merchant address country. |
transactions[].details.merchant.firstLine |
string,null |
No | Merchant address street. |
transactions[].details.merchant.name |
string |
No | Merchant name. |
transactions[].details.merchant.postCode |
string |
No | Merchant address postal code. |
transactions[].details.merchant.state |
string |
No | Merchant address state. |
transactions[].details.paymentReference |
string |
No | Deposit payment reference text. |
transactions[].details.rate |
number |
No | Conversion exchange rate. |
transactions[].details.senderAccount |
string |
No | Deposit sender bank account details. |
transactions[].details.senderName |
string |
No | Deposit sender name. |
transactions[].details.sourceAmount |
object |
No | Source amount for conversions. |
transactions[].details.sourceAmount.currency |
string |
No | |
transactions[].details.sourceAmount.value |
number |
No | |
transactions[].details.targetAmount |
object |
No | Target amount for conversions. |
transactions[].details.targetAmount.currency |
string |
No | |
transactions[].details.targetAmount.value |
number |
No | |
transactions[].details.type |
enum: CARD, CONVERSION, DEPOSIT, TRANSFER, MONEY_ADDED, INCOMING_CROSS_BALANCE, ... |
No | Transaction type. |
transactions[].exchangeDetails |
object,null |
No | Exchange details for card transactions abroad. |
transactions[].exchangeDetails.forAmount |
object |
No | |
transactions[].exchangeDetails.forAmount.currency |
string |
No | |
transactions[].exchangeDetails.forAmount.value |
number |
No | |
transactions[].exchangeDetails.rate |
number,null |
No | Exchange rate applied. |
transactions[].referenceNumber |
string |
No | Wise assigned unique transaction reference number. Can be used to map refunds to the original transfer. |
transactions[].runningBalance |
object |
No | Running balance after the transaction. |
transactions[].runningBalance.currency |
string |
No | |
transactions[].runningBalance.value |
number |
No | |
transactions[].totalFees |
object |
No | Transaction fees. |
transactions[].totalFees.currency |
string |
No | Currency code. |
transactions[].totalFees.value |
number |
No | Fee amount. |
transactions[].type |
enum: DEBIT, CREDIT |
No | Transaction direction. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.