Read all bank accounts

curl --request GET \
  --url https://api.lumx.io/bank-accounts \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Lumx Brazil Operations Account",
      "type": "EXTERNAL",
      "rail": "PIX",
      "currency": "BRL",
      "identifier": {
        "keyType": "CNPJ",
        "keyValue": "42.887.120/0001-00"
      },
      "holder": {
        "relationship": "SELF",
        "legalName": "Lumx S.A",
        "taxId": "42.887.120/0001-00",
        "incorporationDate": "2020-01-01",
        "email": "[email protected]",
        "address": {
          "line1": "Rua Voluntarios da Patria 89",
          "city": "Rio de Janeiro",
          "state": "RJ",
          "postalCode": "22270-000",
          "country": "BRA"
        },
        "verification": {
          "status": "APPROVED",
          "level": "BASIC"
        }
      },
      "createdAt": "2025-10-16T12:30:00.000Z",
      "updatedAt": "2025-10-16T12:30:00.000Z"
    }
  ]
}

GET

bank-accounts

curl --request GET \
  --url https://api.lumx.io/bank-accounts \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Lumx Brazil Operations Account",
      "type": "EXTERNAL",
      "rail": "PIX",
      "currency": "BRL",
      "identifier": {
        "keyType": "CNPJ",
        "keyValue": "42.887.120/0001-00"
      },
      "holder": {
        "relationship": "SELF",
        "legalName": "Lumx S.A",
        "taxId": "42.887.120/0001-00",
        "incorporationDate": "2020-01-01",
        "email": "[email protected]",
        "address": {
          "line1": "Rua Voluntarios da Patria 89",
          "city": "Rio de Janeiro",
          "state": "RJ",
          "postalCode": "22270-000",
          "country": "BRA"
        },
        "verification": {
          "status": "APPROVED",
          "level": "BASIC"
        }
      },
      "createdAt": "2025-10-16T12:30:00.000Z",
      "updatedAt": "2025-10-16T12:30:00.000Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header on the format Bearer <API_KEY>.

Query Parameters

size

integer

default:25

Number of bank accounts to return per page.

Required range: 1 <= x <= 100

cursor

string<uuid>

Cursor for pagination. Use the nextCursor or previousCursor from the previous response to get the next or previous page.

customerId

string<uuid>

Filter bank accounts by customer's unique identifier.

Response

200 - application/json

Bank accounts successfully retrieved.

data

object[]

An array containing all bank accounts.

Show child attributes

data.id

string<uuid>

Bank account's unique identifier.

Example:

"e80d3137-eddd-4791-b9b8-6e36b289f284"

data.customerId

string<uuid>

Customer's unique identifier.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

data.name

string

Bank account's display name.

data.type

enum<string>

Bank account's type.

Available options:

EXTERNAL

data.rail

enum<string>

Bank account's payment rail.

Available options:

PIX,

SWIFT,

SEPA,

ACH,

FEDWIRE

data.currency

string

Bank account's currency.

data.identifier

object

Bank account's identifier.

data.bank

object

Bank information.

data.holder

object

Bank account's holder.

Show child attributes

data.holder.relationship

string

Holder's relationship to customer.

data.holder.legalName

string

Holder's legal name.

data.holder.taxId

string

Holder's tax ID.

data.holder.incorporationDate

string<date>

Holder's incorporation date.

data.holder.email

string<email>

Holder's email address.

data.holder.address

object

Holder's address.

Show child attributes

data.holder.address.line1

string

required

Address line 1.

Example:

"123 Main Street"

data.holder.address.city

string

required

Address city.

Example:

"Frankfurt"

data.holder.address.state

string

required

Address state.

Example:

"HE"

data.holder.address.postalCode

string

required

Address postal code.

Example:

"60311"

data.holder.address.country

string

required

Address country code (ISO 3166-1 alpha-3).

Example:

"DEU"

data.holder.address.line2

string

Address line 2.

Example:

"Apt 4B"

data.holder.verification

object

Holder verification information.

Show child attributes

data.holder.verification.status

string

Verification status.

data.holder.verification.level

string

Verification level.

data.intermediary

object

Intermediary bank information.

data.createdAt

string<date-time>

Creation date and time (UTC).

data.updatedAt

string<date-time>

Last update date and time (UTC).

Read a verification

Create a bank account

⌘I

Customers

Bank Accounts

Exchange Rates

Transactions

Partner Fees

Read all bank accounts

Authorizations

Query Parameters

Response