Bank Account Details
Bank account detail endpoints are provided to create, view, and manage bank account details for an account balance.
Via the Multi-Currency Accounts and Balance Accounts sections of this guide, you will know the profile and multi-currency account, as well as the specific balance accounts created. The next optional steps are:
- List current bank account details - View a list of all existing bank account details for the multi-currency account.
- Request bank account details - Create a request for bank account details to be added to the profile and multi-currency account.
- List bank account detail orders - View open requests for bank account details on the profile and multi-currency account.
GET /v1/profiles/{{profileId}}/account-details-orders
This endpoint returns the bank account assignment requests for a profile and multi-currency account.
curl -X GET https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/account-details-orders \-H 'Authorization: Bearer <your api token>'
[{"status": "PENDING_USER","currency": "EUR","requirements": [{"type": "TOP_UP","status": "PENDING_USER",},{"type": "VERIFICATION","status": "PENDING_USER",}]},...]
POST /v1/profiles/{{profileId}}/account-details-orders
Creates an order which will issue account details. It should use the same currency as the balance previously created. Fulfilling all the requirements will complete the order. That means reaching status DONE
.
The possible values for a requirement are:
PENDING_USER
: The requirement has some pending action from the user.PENDING_TW
: The requirement has some pending action from Wise.DONE
: The requirement is completed
The more common requirements are:
VERIFICATION
: The user needs to be fully verified before complete this requirement.TOP_UP
: A fee will be charged and must be paid using through wise.com before complete this requirement.
balance currency (ISO 4217 Alphabetic Code)
Status (PENDING_USER
, PENDING_TW
, DONE
)
currency (ISO 4217 Alphabetic Code)
Requirement type (VERIFICATION
, TOP_UP
)
Requirement status (PENDING_USER
, PENDING_TW
, DONE
)
curl -X POST https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/account-details-orders \-H 'Authorization: Bearer <your api token>' \-H 'Content-Type: application/json' \-d '{"currency": "EUR"}'
{"status": "PENDING_USER","currency": "EUR","requirements": [{"type": "VERIFICATION","status": "PENDING_USER"}]}
GET /v1/profiles/{{profileId}}/account-details
This endpoint returns a list with all the AVAILABLE
and ACTIVE
account details for the given profile, including examples. Account receive options can also include local and international details to receive money on the currency balance.
Example bank account details are returned for any currency where bank account details have not been requested and issued. Examples will always include an id
of null
.
Response
Returns a list of bank account details objects.
curl -X GET https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/account-details \-H 'Authorization: Bearer <your api token>'