Liste todos os seus recebedores.

Método

import { Malga } from 'malga'

const malga = new Malga({
  apiKey: '17a64c8f-a387-4682-bdd8-d280493715e0',
  clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
})

await malga.customers.list()
{
  items: [
    {
      id: 'c1015d17-f123-499f-aaad-32e7f7812132',
      clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
      status: 'pending',
      merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
      mcc: 4040,
      owner: {
        name: 'João da Silva',
        email: 'joao.silva@test.com',
        phoneNumber: '99999999999',
        birthdate: '2000-12-31'
        document: {
          number: '99999999999',
          type: 'cpf',
          country: 'BR'
        },
        address: {
          city: 'Rio de Janeiro',
          complement: 'Sala 214',
          country: 'BR',
          district: 'São Conrado',
          state: 'RJ',
          street: 'Estrada da Gávea',
          streetNumber: '696',
          zipCode: '22610002'
        }
      },
      bankAccount: {
        holderName: 'João da Silva'
        holderDocument: '99999999999',
        bank: '077'
        branchNumber: '492',
        accountNumber: '4929',
        type: 'conta_corrente'
      },
      transferPolicy: {
        transferDay: '5'
        transferEnabled: true
        transferInterval: 'monthly'
      },
      providers: [{
        providerType: 'SANDBOX',
        externalId: '1103976',
        externalStatus: 'active',
        externalStatusReason: 'ok',
        status: 'active',
        createdAt: '2023-12-31T16:08:39.536Z',
        updatedAt: '2023-12-31T16:08:39.536Z'
      }]
    }
  ],
  meta: {
    totalItems: 1
    itemCount: 1
    itemsPerPage: 15
    totalPages: 1
    currentPage: 1
  }
}

Parâmetros

Lista de todos os parâmetros suportados pelo método.

page
number

Número da página que deverá ser listada

limit
number

Limite de itens por página

sort
string

Ordenação da listagem, padrão é ASC



Os valores suportados são: ASC ou DESC

email
string

E-mail do recebedor

status
array

Status do recebedor