List all bank rails

Return every supported bank rail. Rails the user has activated come from the Bank table (with status / iban_data); rails the user has not activated are returned from the static BANK_INFO registry with status=not_started and iban_data=None. If a rail’s provider KYC is APPROVED but no ACTIVE Bank row exists yet, syncs lazily from Swipelux / Align before returning.

GET /api/v1/banks

List all bank rails

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/banks \
  --header 'Authorization: Bearer <token>'

200

{
  "banks": [
    {
      "bankName": "<string>",
      "country": "<string>",
      "currency": "<string>",
      "methods": [],
      "pooled": true,
      "compliance": 123,
      "bankIcon": "<string>",
      "depositFee": 123,
      "accountHolderBusinessName": "<string>",
      "accountHolderFirstName": "<string>",
      "accountHolderLastName": "<string>",
      "ibanData": {
        "bankName": "<string>",
        "ibanNumber": "<string>",
        "beneficiaryName": "<string>",
        "bankAddress": "<string>",
        "currency": "<string>",
        "accountHolderFirstName": "<string>",
        "accountHolderLastName": "<string>",
        "accountHolderBusinessName": "<string>",
        "accountHolderAddress": {
          "streetAddress": "<string>",
          "addressLine2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>"
        },
        "paymentReference": "<string>",
        "accountType": "sepa",
        "bic": "<string>"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalAccountId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "rails": {
    "us": {
      "pooled": false,
      "named": false
    },
    "swift": {
      "pooled": false,
      "named": false
    },
    "eu": {
      "pooled": false,
      "named": false
    },
    "uae": {
      "pooled": false,
      "named": false
    }
  },
  "allOptions": [
    {
      "bankName": "<string>",
      "country": "<string>",
      "currency": "<string>",
      "methods": [],
      "pooled": true,
      "compliance": 123,
      "bankIcon": "<string>",
      "depositFee": 123,
      "accountHolderBusinessName": "<string>",
      "accountHolderFirstName": "<string>",
      "accountHolderLastName": "<string>",
      "ibanData": {
        "bankName": "<string>",
        "ibanNumber": "<string>",
        "beneficiaryName": "<string>",
        "bankAddress": "<string>",
        "currency": "<string>",
        "accountHolderFirstName": "<string>",
        "accountHolderLastName": "<string>",
        "accountHolderBusinessName": "<string>",
        "accountHolderAddress": {
          "streetAddress": "<string>",
          "addressLine2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>"
        },
        "paymentReference": "<string>",
        "accountType": "sepa",
        "bic": "<string>"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalAccountId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Response

200

application/json

Successful Response

List bank rails plus user's requested rail preferences.

banks · BankResponse · object[] · required

Show child attributes

rails · BankRequestedRails · object · required

Rails the user is interested in opening.

Show child attributes

allOptions · BankResponse · object[]

Show child attributes