What this client still has to provide before the rail can open

A pure read: it opens nothing, writes nothing and calls no provider.

GET /banks/{rail}/requirements

What this client still has to provide before the rail can open

cURL

curl --request GET \
  --url https://api.example.com/banks/{rail}/requirements \
  --header 'Authorization: Bearer <token>'

200

{
  "rail": "<string>",
  "currency": "<string>",
  "method": "sepa",
  "available": true,
  "requires": {
    "phone": true,
    "address": true,
    "kyb": true
  },
  "kybStatus": "notStarted",
  "kycStatus": "notStarted",
  "blockers": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Headers

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Path Parameters

rail · string · required

Opaque rail id

Example:

"wire_named"

Response

200

application/json

Successful Response

rail · string · required

Stable HEVN identifier for this receiving payment method.

currency · string · required

ISO 4217 fiat currency code received through this payment method.

method · enum<string> · required

Payment network or method represented by this rail.

Available options: sepa, swift, ach, uaefts, fedwire, rtp, fednow, pix, spei, pse, breb, transfers_3_0, ukfps, npp, nip, bdt_local, bdt_ewallet, bob_local, brl_local, cad_eft, clp_local, cny_alipay, cny_wechatpay, cop_local, crc_local, dkk_local, dop_local, dop_ewallet, egp_local, gtq_local, gtq_ewallet, hkd_fps, hnl_local, idr_local, idr_ewallet, ils_local, inr_local, inr_upi, jmd_local, jpy_local, krw_local, myr_local, nok_local, php_local, php_ewallet, pkr_raast, pkr_ewallet, pln_local, sar_local, sle_local, thb_local, try_fast, tzs_local, ugx_local, vnd_local, xof_local, zmw_local

available · boolean · required

Whether this payment method can currently be requested.

requires · RailRequiresView · object · required

Profile and verification work required before opening.

Show child attributes

kybStatus · enum<string> · required

Current business-verification status.

Available options: notStarted, pending, approved, rfi, rejected

kycStatus · enum<string> · required

Current identity-verification status for this payment method.

Available options: notStarted, requested, incorporating, pending, underReview, documentRequested, approved, rejected

blockers · RailBlockerView · object[]

Reasons this payment method cannot currently be requested.

Show child attributes