Liste todas as suas cobranças.

​
Método

import { Malga } from 'malga'

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

await malga.charges.list()

{
  items: [
    {
      id: 'e09ef791-1aaa-4b11-8173-698f2689a04d',
      clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
      merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
      description: null,
      orderId: null,
      providerReferenceKey: null,
      createdAt: '2023-12-31T18:19:44.993Z',
      amount: 100,
      originalAmount: 100,
      currency: 'BRL',
      statementDescriptor: null,
      capture: false,
      isDispute: false,
      status: 'pre_authorized',
      paymentMethod: {
        installments: 1,
        paymentType: 'credit',
      },
      paymentSource: {
        sourceType: 'card',
        cardId: '3db399d3-44c1-49fe-ab26-6fb00c161337',
      },
      transactionRequests: [
        {
          id: 'a6cc6bda-3f6d-4277-8ea2-e4bbd9166f16',
          createdAt: '2023-12-31T18:19:45.013Z',
          updatedAt: '2023-12-31T18:19:45.044Z',
          idempotencyKey: '3b42ede3-15a8-4d81-b6e9-54c5762776c6',
          providerId: '694f7eee-2966-4825-a847-65d070cbdece',
          providerType: 'SANDBOX',
          transactionId: '18242a4d-dd35-475f-b79b-5cbe8f9d1fea',
          amount: 100,
          authorizationCode: '123123',
          authorizationNsu: '123123',
          requestStatus: 'success',
          requestType: 'pre_authorization',
          responseTs: '11ms',
          providerAuthorization: {
            networkAuthorizationCode: '123123',
            networkResponseCode: '123123',
          }
        }
      ],
      appInfo: null
    }
  ],
  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

​
startDate
string

Data inicial do período filtrado

​
endDate
string

Data final do período filtrado

​
merchantId
uuid

ID do Merchant

​
amount
number

Valor da cobrança

​
orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

​
hasSplit
boolean

Cobranças que foram feitas com Split de pagamentos

​
sessionId
uuid

Cobrança vinculada à Sessão

​
status
array

Status atual da cobrança

​
paymentMethod
array

Método de pagamento da cobrança

​
provider
array

Provedor utilizado na cobrança