Skip to main content
POST
/
api
/
v1
/
accounts
/
banks
/
activate
Activate multiple bank rails
curl --request POST \
  --url https://api.hevn.finance/api/v1/accounts/banks/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rails": []
}'
{
  "results": [
    {
      "ok": true,
      "bank": {
        "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"
      },
      "error": {
        "statusCode": 123,
        "message": "<string>",
        "detail": null
      }
    }
  ]
}

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

Body

application/json

Bulk bank activation request.

​
rails
enum<string>[]
required

Bank account route: provider rail + bank id ({rail}-{bank}).

Available options:
uaefts_named-zand,
ach_pooled-hsbc,
ach_named-citi,
ach_named-jpmorgan_chase,
ach_named-cfsb,
fedwire_pooled-hsbc,
fedwire_pooled-jpmorgan_chase,
fedwire_pooled-cfsb,
fedwire_named-hsbc,
fedwire_named-citi,
fedwire_named-jpmorgan_chase,
fedwire_named-cfsb,
sepa_pooled-zen,
sepa_named-zen,
swift_pooled-hsbc,
swift_named-hsbc

Response

Successful Response

Bulk bank activation response.

​
results
BankActivateRailResult · object[]
required