Skip to main content
GET
/
bank-accounts
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": "hello@lumx.io",
        "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.