List virtual accounts and available payment methods

List receiving payment methods available to the selected account and identify which virtual accounts have already been opened.

GET /banks

List virtual accounts and available payment methods

cURL

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

200

{
  "rails": [
    {
      "rail": "<string>",
      "currency": "<string>",
      "railCurrency": "USD",
      "method": "sepa",
      "opened": true,
      "feeBps": 123,
      "supportedAccounts": [
        "USDC"
      ],
      "status": "preparing",
      "destinationAccount": "USDC",
      "minimumDeposit": "500.00",
      "id": "bnk_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
      "requisites": {
        "fields": {
          "iban": "<string>",
          "bic": "<string>",
          "accountNumber": "<string>",
          "routingNumber": "<string>",
          "pixKey": "<string>",
          "pixKeyType": "phone",
          "paymentKey": "<string>",
          "financialInstitutionId": "<string>",
          "branchNumber": "<string>",
          "accountKind": "checking",
          "phoneNumber": "<string>"
        },
        "holder": {
          "type": "individual",
          "firstName": "<string>",
          "lastName": "<string>",
          "businessName": "<string>",
          "address": {
            "streetAddress": "<string>",
            "addressLine2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country": "AF",
            "zip": "<string>"
          },
          "idType": "passport",
          "idNumber": "<string>",
          "taxId": "<string>",
          "nationality": "<string>"
        },
        "state": "active",
        "bankName": "<string>",
        "paymentReference": "<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"

Response

200

application/json

Successful Response

rails · RailView · object[] · required

Payment methods and virtual-account configurations available to the account.

Show child attributes