Read a bank account

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

{
  "id": "a72f5359-ffef-6913-d1da-8g58d491g406",
  "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-16T15:30:22.456Z",
  "updatedAt": "2025-10-16T15:30:22.456Z"
}

GET

bank-accounts

{id}

Read a bank account

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

{
  "id": "a72f5359-ffef-6913-d1da-8g58d491g406",
  "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-16T15:30:22.456Z",
  "updatedAt": "2025-10-16T15:30:22.456Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header on the format Bearer <API_KEY>.

Path Parameters

string<uuid>

required

Bank account's unique identifier.

Response

200 - application/json

Bank account successfully retrieved.

PIX
SWIFT
SEPA
ACH
FEDWIRE

Bank account's rail is PIX.

string<uuid>

Bank account's unique identifier.

Example:

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

customerId

string<uuid>

Customer's unique identifier.

Example:

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

name

string

Bank account's display name.

Example:

"Lumx Bank Account 1"

type

enum<string>

Bank account's type.

Available options:

EXTERNAL

rail

enum<string>

Bank account's payment rail.

Available options:

PIX

currency

enum<string>

Bank account's currency.

Available options:

BRL

identifier

object

Bank account's identifier.

Show child attributes

identifier.keyType

enum<string>

Identifier PIX key type.

Available options:

CNPJ,

EMAIL,

PHONE,

RANDOM

Example:

"CNPJ"

identifier.keyValue

string

Identifier PIX key value. For phone keys, use E.164 international format starting with + (e.g., +5511987654321).

Example:

"123.456.789-00"

holder

object

Bank account's holder.

Show child attributes

holder.relationship

enum<string>

Holder's relationship to customer.

Available options:

SELF,

HOLDING_COMPANY,

SUBSIDIARY_COMPANY,

BRANCH_OFFICE,

BUSINESS_PARTNER,

SUPPLIER,

CUSTOMER,

CREDITOR,

DEBTOR,

FRANCHISEE

Example:

"SELF"

holder.legalName

string

Holder's legal name.

Example:

"Lumx S.A"

holder.taxId

string

Holder's tax ID.

Example:

"42.887.120/0001-00"

holder.incorporationDate

string<date>

Holder's incorporation date.

Example:

"2020-01-01"

holder.email

string<email>

Holder's email address.

Example:

"[email protected]"

holder.address

object

Holder's address.

Show child attributes

holder.address.line1

string

required

Address line 1.

Example:

"123 Main Street"

holder.address.city

string

required

Address city.

Example:

"Frankfurt"

holder.address.state

string

required

Address state.

Example:

"HE"

holder.address.postalCode

string

required

Address postal code.

Example:

"60311"

holder.address.country

string

required

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

Example:

"DEU"

holder.address.line2

string

Address line 2.

Example:

"Apt 4B"

holder.verification

object

Holder verification information.

Show child attributes

holder.verification.status

enum<string>

Verification status.

Available options:

UNDER_VERIFICATION,

APPROVED,

TEMPORARY_REJECTION,

FINAL_REJECTION

Example:

"APPROVED"

holder.verification.level

string

Verification level.

Example:

"BASIC"

createdAt

string<date-time>

Creation date and time (UTC).

updatedAt

string<date-time>

Last update date and time (UTC).

Create a bank account

Get an exchange rate

⌘I

Customers

Bank Accounts

Exchange Rates

Transactions

Partner Fees

Read a bank account

Authorizations

Path Parameters

Response