Bank details

Bank details for incoming transfers

GET/v1/accounts/:accountId/bank-details

Auth: Bearer access token — how to use the access token.

Scopes: tb:accounts:read

The client wants to receive an incoming transfer; the partner requests the details to pass to the sender.

GET/v1/accounts/:accountId/bank-details

curl -G 'https://sandbox-bank.tedr.com/open-banking/v1/accounts/<accountId>/bank-details' \
  -H 'Authorization: Bearer <access-token>' \
  --data-urlencode 'currencyIds[]=99d41c98-93d1-471a-a73a-4cac9e3587e7'

const query = new URLSearchParams({
  'currencyIds[]': '99d41c98-93d1-471a-a73a-4cac9e3587e7',
});


const response = await fetch(`https://sandbox-bank.tedr.com/open-banking/v1/accounts/<accountId>/bank-details?${query}`, {
  headers: { Authorization: 'Bearer <access-token>' },
});


const { data } = await response.json();

import requests


response = requests.get(
    'https://sandbox-bank.tedr.com/open-banking/v1/accounts/<accountId>/bank-details',
    headers={'Authorization': 'Bearer <access-token>'},
    params={'currencyIds[]': '99d41c98-93d1-471a-a73a-4cac9e3587e7'},
)


data = response.json()['data']

{
  "status": "SUCCESS",
  "data": {
    "virtualAccountId": "05155318-22a3-45aa-9db0-0ebfe8f21e8c",
    "bankDetails": [
      {
        "currency": {
          "id": "99d41c98-93d1-471a-a73a-4cac9e3587e7",
          "ticker": "USD",
          "network": { "name": "FIAT" }
        },
        "routes": [
          {
            "schema": "INNER",
            "details": {
              "virtualAccountId": "05155318-22a3-45aa-9db0-0ebfe8f21e8c"
            }
          },
          {
            "schema": "SWIFT",
            "details": {
              "beneficiary": {
                "name": "Example Holdings Ltd",
                "address": "1 Example Street, Exampletown, EX1 2AB"
              },
              "beneficiaryBank": {
                "account": "0000000000",
                "code": "EXMPUS33XXX",
                "name": "EXAMPLE BANK",
                "address": null,
                "country": {
                  "alpha2": "US",
                  "alpha3": "USA",
                  "name": "United States"
                }
              },
              "correspondentBanks": [],
              "remittanceInformation": [
                "For own account transfer",
                "Actual purpose of payment"
              ]
            }
          }
        ]
      }
    ]
  }
}

currencyIds is optional — without it the details for every currency of the account are returned.

How to read routes

Routes
Route	Use
INNER	For receiving from another user of the system; passing the sender the `virtualAccountId` is enough.
SWIFT	For an international bank transfer; pass on `beneficiary` and `beneficiaryBank`.
BSB · IFSC	The same idea for Australia / India, when the account has such a route.

One currency can expose several routes at once; the sender picks whichever suits them.

The bank details in the response example are example values.