Skip to main content
POST
/
api
/
v1
/
accounts
/
bank
/
{rail}
/
activate
Activate a bank rail
curl --request POST \
  --url https://api.hevn.finance/api/v1/accounts/bank/{rail}/activate \
  --header 'Authorization: Bearer <token>'
{
  "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

Path Parameters

​
rail
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

Bank row as returned to clients.

Merges static rail metadata (from BANK_INFO) with per-user state. For rails the user hasn't activated yet, id / external_account_id / created_at are None and status is not_started.

​
rail
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
​
bankName
string
required
​
country
string
required
​
currency
string
required
​
type
enum<string>
required

Canonical fiat payment rail used for account_type discrimination, bank-rail methods, and contact/transaction type alignment.

Available options:
sepa,
swift,
ach,
uaefts,
fedwire
​
method
enum<string>
required

Canonical fiat payment rail used for account_type discrimination, bank-rail methods, and contact/transaction type alignment.

Available options:
sepa,
swift,
ach,
uaefts,
fedwire
​
methods
enum<string>[]
required

Canonical fiat payment rail used for account_type discrimination, bank-rail methods, and contact/transaction type alignment.

Available options:
sepa,
swift,
ach,
uaefts,
fedwire
​
pooled
boolean
required
​
compliance
integer
required
​
bankIcon
string
required
​
depositFee
number
required
​
timeToOpen
enum<string>
required

Expected wait time before a bank rail becomes usable.

Available options:
<1 day,
1-2 days,
2-3 days,
5-7 days
​
status
enum<string>
required

IBAN account status.

State machine: not_started → requested → document_requested → approved → pending → active

  • not_started — default for every rail until the user opts in.
  • requested — user asked for this rail via /pre-approve; awaiting KYC.
  • document_requested— admin asked the user for more documents (KYB).
  • approved — KYB passed, account ready to be created at provider.
  • pending_kyc — provider rejected creation until KYC is approved.
  • pending — provider accepted/created the account, waiting.
  • active — real bank details are attached to the row.
  • frozen / closed— terminal/blocked states.
Available options:
not_started,
requested,
document_requested,
approved,
pending_kyc,
pending,
active,
hidden,
frozen,
closed,
rejected
​
accountHolderBusinessName
string | null
​
accountHolderFirstName
string | null
​
accountHolderLastName
string | null
​
ibanData
IBANAccountDetails · object

IBAN (SEPA) external account.

​
id
string<uuid> | null
​
externalAccountId
string | null
​
createdAt
string<date-time> | null