API

AccountDetail

Bank account details by id.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Method Route SDK operation Returns
GET /balances/account-details/{id} load GetAccountDetails 200 response

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:

account_detail, err := client.AccountDetail(nil).Load(map[string]any{"id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(account_detail)

Lua

Construct client as shown in the Lua setup, then call the operations:

local account_detail, err = client:AccountDetail():load({ id = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$account_detail = $client->AccountDetail()->load(["id" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

account_detail = client.AccountDetail().load({"id": 1})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

account_detail = client.AccountDetail.load({ "id" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const account_detail = await client.AccountDetail().load({ id: 1 })

Fields

Field Type Required Description
accountHolderName string Yes Name of the account holder as it appears on the account details.
accountIdentification any Yes Country/scheme-specific account identification.
country string Yes ISO 3166-1 alpha-2 country code the account details belong to.
id integer Yes Unique identifier for the account details.
profileId integer Yes Profile ID of the account details owner.
state string Yes Current state of the account details.

load

GET /balances/account-details/{id}

Operation ID: getAccountDetails.

Authentication: bearer token (ClientCredentialsToken) or bearer token (UserToken).

Parameters

Parameter In Type Required Description
id path integer (int64) Yes Unique identifier for the account details.
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: GetAccountDetails 200 response

application/json

Property Type Required Description
accountHolderName string Yes Name of the account holder as it appears on the account details.
accountIdentification object or object or object Yes Country/scheme-specific account identification.
country string Yes ISO 3166-1 alpha-2 country code the account details belong to.
id integer (int64) Yes Unique identifier for the account details.
profileId integer (int64) Yes Profile ID of the account details owner.
state enum: ACTIVE, INACTIVE Yes Current state of the account details.
404: AccountDetailsNotFoundError 404 response
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.