Documentation Index
Fetch the complete documentation index at: https://docs.malga.io/llms.txt
Use this file to discover all available pages before exploring further.
Uma cobrança charge representa um pagamento realizado através da Malga, que pode englobar diversas transações em provedores de cobrança e de antifraude, contendo as informações sobre o seu processamento.
No grupo Charges disponibilizamos as seguintes consultas:
allCharges | Retorna todas as cobranças |
charge | Retorna informações de uma cobrança pelo seu identificador único |
chargesByDeclinedCode | Retorna as cobranças com status failed pelo declined code (motivos de perda) |
totalCharges | Retorna o número de cobranças e o total financeiro de um período |
totalChargesByInterval | Retorna o número de cobranças e o total financeiro por um intervalo selecionado |
totalChargesByPaymentMethod | Retorna o número de cobranças e o total financeiro processados por método de pagamento |
totalChargesByProviderType | Retorna o número de cobranças e o total financeiro processados por provedor de pagamento |
allCharges
Retorna todas as cobranças
| QUERY : OBJETO DE RETORNO | allCharges: ChargeConnection |
| ARGUMENTO : TIPO | DESCRIÇÃO |
| first: Int | Retorna os primeiros n elementos da lista. O padrão é 100 |
| after: String | Retorna os elementos da lista que vêm após o ID global especificado. |
| startDate: Datetime | startDate (intervalo de datas, iniciando o range no formato yyyy-MM-dd HH:mm:ss.SSSS) |
| endDate: Datetime | endDate (intervalo de datas, finalizando o range no formato yyyy-MM-dd HH:mm:ss.SSSS) |
| status: [String!] | Status da transação |
| providerType: [String!] | Nome do provedor |
| paymentMethod: [String!] | Método de pagamento |
| merchantId: [String!] | ID da Subconta |
| orderId: [String!] | Identificador único do cliente para conciliação futura |
| amount: Int | Valor da transação |
| originalAmount: Int | Valor original da transação enviada ao provedor |
| totalPaidAmount: Int | Valor total efetivamente pago pelo comprador na transação. Pode incluir encargos adicionais, como juros ou taxas repassadas ao pagador pelo provedor de pagamento. Atualmente apenas no Mercado Pago |
charge
Retorna informações de uma cobrança pelo seu identificador único
| QUERY : OBJETO DE RETORNO | | charge: ChargeConnection |
| ARGUMENTO : OBJETO | | DESCRIÇÃO |
| id: String | ID da cobrança |
| authorizationCode: String | Código de autorização retornado pelo provedor |
| authorizationNsu: String | Número de autorização retornado pelo provedor |
| idempotencyKey: String | Chave única de referência gerada pela Malga para cada requisição |
chargesByDeclinedCode
Retorna as cobranças com status failed pelo declined code (motivos de perda)
| QUERY : OBJETO DE RETORNO | | chargesByDeclinedCode: DeclinedCode |
| ARGUMENTO : OBJETO | | DESCRIÇÃO |
| startDate: Datetime! | startDate (intervalo de datas, iniciando o range no formato yyyy-MM-dd) |
| endDate: Datetime! | endDate (intervalo de datas, finalizando o range no formato yyyy-MM-dd) |
| currency: String! | Moeda da transação |
| merchantId: [String!] | Lista de subcontas (merchantId’s) das transações |
totalCharges
Retorna o número de cobranças e o total financeiro de um período
| QUERY : OBJETO DE RETORNO | | totalCharges: TotalCharges |
| ARGUMENTO : OBJETO | | DESCRIÇÃO |
| startDate: Datetime! | startDate (intervalo de datas, iniciando o range no formato yyyy-MM-dd) |
| endDate: Datetime! | endDate (intervalo de datas, finalizando o range no formato yyyy-MM-dd) |
| currency: String! | Moeda da transação |
| status: [String!] | Status da transação |
| merchantId: [String!] | Lista de subcontas (merchantId’s) das transações |
totalChargesByInterval
Retorna o número de cobranças e o total financeiro por um intervalo selecionado
| QUERY : OBJETO DE RETORNO | | totalChargesByInterval: TotalCharges |
| ARGUMENTO : OBJETO | | DESCRIÇÃO |
| startDate: Datetime! | startDate (intervalo de datas, iniciando o range no formato yyyy-MM-dd) |
| endDate: Datetime! | endDate (intervalo de datas, finalizando o range no formato yyyy-MM-dd) |
| interval: String! | Intervalo de agrupamento [DAY, WEEK, MONTH, YEAR] |
| currency: String! | Moeda da transação |
| status: [String!] | Status da transação |
| merchantId: [String!] | Lista de subcontas (merchantId’s) das transações |
totalChargesByPaymentMethod
Retorna o número de cobranças e o total financeiro processados por método de pagamento
| QUERY : OBJETO DE RETORNO | | totalChargesByPaymentMethod: TotalCharges |
| ARGUMENTO : OBJETO | | DESCRIÇÃO |
| startDate: Datetime! | startDate (intervalo de datas, iniciando o range no formato yyyy-MM-dd) |
| endDate: Datetime! | endDate (intervalo de datas, finalizando o range no formato yyyy-MM-dd) |
| currency: String! | Moeda da transação |
| status: [String!] | Status da transação |
| merchantId: [String!] | Lista de subcontas (merchantId’s) das transações |
totalChargesByProviderType
Retorna o número de cobranças e o total financeiro processados por provedor de pagamento
| QUERY : OBJETO DE RETORNO | | totalChargesByProviderType: TotalCharges |
| ARGUMENTO : OBJETO | | DESCRIÇÃO |
| startDate: Datetime! | startDate (intervalo de datas, iniciando o range no formato yyyy-MM-dd) |
| endDate: Datetime! | endDate (intervalo de datas, finalizando o range no formato yyyy-MM-dd) |
| currency: String! | Moeda da transação |
| status: [String!] | Status da transação |
| merchantId: [String!] | Lista de subcontas (merchantId’s) das transações |
