BankAccountDetailsOrder
An order for bank account details: create one, or list them.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
POST |
/profiles/{profileId}/account-details-orders |
create |
Bank account details order created. The objects in the requirements array include the type and status of each requirement. All requirements must be fulfilled to complete the order. |
GET |
/profiles/{profileId}/account-details-orders |
list |
A list of bank account detail orders |
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:
bank_account_details_orders, err := client.BankAccountDetailsOrder(nil).List(map[string]any{"profile_id": 1, "currency": "example"}, nil)
if err != nil {
panic(err)
}
fmt.Println(bank_account_details_orders)
created, err := client.BankAccountDetailsOrder(nil).Create(map[string]any{"profile_id": 1, "currency": "example"}, nil)
if err != nil {
panic(err)
}
fmt.Println(created)
Lua
Construct client as shown in the Lua setup, then call the operations:
local bank_account_details_orders, err = client:BankAccountDetailsOrder():list({ profile_id = 1, currency = "example" })
local created, err = client:BankAccountDetailsOrder():create({ profile_id = 1, currency = "example" })
PHP
Construct client as shown in the PHP setup, then call the operations:
$bank_account_details_orders = $client->BankAccountDetailsOrder()->list(["profile_id" => 1, "currency" => "example"]);
$created = $client->BankAccountDetailsOrder()->create(["profile_id" => 1, "currency" => "example"]);
Python
Construct client as shown in the Python setup, then call the operations:
bank_account_details_orders = client.BankAccountDetailsOrder().list({"profile_id": 1, "currency": "example"})
created = client.BankAccountDetailsOrder().create({ "profile_id": 1, "currency": "example" })
Ruby
Construct client as shown in the Ruby setup, then call the operations:
bank_account_details_orders = client.BankAccountDetailsOrder.list({ "profile_id" => 1, "currency" => "example" })
created = client.BankAccountDetailsOrder.create({ "profile_id" => 1, "currency" => "example" })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const bank_account_details_orders = await client.BankAccountDetailsOrder().list({ profile_id: 1, currency: "example" })
const created = await client.BankAccountDetailsOrder().create({ profile_id: 1, currency: "example" })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
accountDetailsId |
integer |
No | Unique ID of the issued account details. |
balanceId |
one,integer,null |
No | ID of the balance the order is for. |
creationTime |
string |
No | Timestamp of when the order was created. |
currency |
string |
No | Currency code (ISO 4217 Alphabetic Code). |
id |
string |
No | Unique ID of the order. |
modificationTime |
string |
No | Timestamp of the last modification to the order. |
requirements |
array |
No | List of requirements to fulfill the order. |
status |
string |
No | Order status. |
create
POST /profiles/{profileId}/account-details-orders
Operation ID: bankAccountDetailsOrderCreate.
Authentication: bearer token (UserToken) or bearer token (PersonalToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | The ID of the profile to create the bank account details order for. |
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. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
currency |
string |
Yes | Balance currency (ISO 4217 Alphabetic Code) for the requested bank account details. |
Responses
200: Bank account details order created. The objects in the requirements array include the type and status of each requirement. All requirements must be fulfilled to complete the order.
application/json
| Property | Type | Required | Description |
|---|---|---|---|
currency |
string |
No | Currency code (ISO 4217 Alphabetic Code). |
requirements |
array of object |
No | List of requirements to fulfill the order. |
requirements[].status |
enum: PENDING_USER, PENDING_TW, DONE, FAILED, REFUNDED, WAIVED |
No | Requirement status. The following values indicate pending actions: - PENDING_USER: The requirement has some pending action from the user. - PENDING_TW: The requirement has some pending action from Wise. |
requirements[].type |
enum: VERIFICATION, TOP_UP, FEE, PARTNER_APPROVAL, TERMS_ACCEPTANCE |
No | Requirement type. The most common requirements types: - VERIFICATION: The user needs to be fully verified before account details can be issued. - TOP_UP: A fee will be charged and must be paid through wise.com before account details can be issued. |
status |
enum: PENDING_USER, PENDING_TW, REQUIREMENTS_FULFILLED, DONE |
No | Order status. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
list
GET /profiles/{profileId}/account-details-orders
Operation ID: bankAccountDetailsOrdersList.
Authentication: bearer token (UserToken) or bearer token (PersonalToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | The ID of the profile to list bank account detail orders for. |
currency |
query |
string |
Yes | Currency code (ISO 4217 Alphabetic Code). |
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: A list of bank account detail orders
application/json
| Property | Type | Required | Description |
|---|---|---|---|
[].accountDetailsId |
integer |
No | Unique ID of the issued account details. Populated only for completed orders. |
[].balanceId |
integer,null |
No | ID of the balance the order is for. If null, primary balance can be assumed. |
[].creationTime |
string (date-time) |
No | Timestamp of when the order was created. |
[].currency |
string |
No | Currency code (ISO 4217 Alphabetic Code) for the balance account. |
[].id |
string (uuid) |
No | Unique ID of the order. |
[].modificationTime |
string (date-time) |
No | Timestamp of the last modification to the order. |
[].requirements |
array of object |
No | List of requirements for the order. |
[].requirements[].status |
enum: PENDING_USER, PENDING_TW, FAILED, DONE, REFUNDED, WAIVED |
No | Requirement status. The following values indicate pending actions: - PENDING_USER: The requirement has some pending action from the user. - PENDING_TW: The requirement has some pending action from Wise. |
[].requirements[].type |
enum: VERIFICATION, TOP_UP, FEE, PARTNER_APPROVAL, TERMS_ACCEPTANCE |
No | Requirement type. |
[].status |
enum: PENDING_USER, PENDING_TW, REQUIREMENTS_FULFILLED, DONE |
No | Order status. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.