Glossário - Malga

Objeto [type]

Cada parte de um esquema em GraphQL é um tipo de objeto, que consiste em uma lista de campos e o valor de cada campo.

Esquema [schema]

O esquema (schema), ou sistema de tipos (types), é a base de qualquer serviço em GraphQL e descreve o escopo de todas as entidades (types) e consultas (queries) disponíveis pela API.Com o esquema, é possível realizar a validação de cada requisição enviada, além de permitir a relação de consultas de introspecção, possibilitando o entendimento das entidades descritas no esquema.

Consulta [queries]

A consulta (query) descreve como é feita a leitura dos dados em GraphQL e como a operação irá retornar os dados do servidor, permitindo a consulta de diferentes entidades em cada requisição.Na Analytics API da Malga, estão disponíveis as entidades de Charges, Cards, Dashboard, Authorization Rate e Subacquirer.

Campo [field]

Cada campo corresponde a uma unidade de dados que é retornada dentro do objeto.

Argumento [argument]

Os campos de um objeto em GraphQL podem ser descritos como uma função que retorna um valor e que aceitam argumentos pré-definidos, onde cada argumento pode ser qualquer campo que não seja um objeto.Na Analytics API Malga, disponibilizamos argumentos como filtros por ID e status de transação, que podem ser aplicados aos conjuntos de dados das entidades.

Subacquirer — feature

A feature identifica o contexto do saldo do subadquirente. Valores possíveis: NUPAY, SUBACQUIRER, GENERAL e SUBACQUIRER_PREPAYMENT. O padrão é SUBACQUIRER.

Subacquirer — seller / sellerId

O seller é o recebedor cadastrado para split de pagamentos. O argumento sellerId filtra o saldo de um seller específico. Quando omitido, a consulta resolve para o client master (o client cujo reference_client_id não está associado a um seller), e não para a soma de todos os sellers.

Subacquirer — reconciled_order

Ordens conciliadas (subacquirer_reconciled_order) que compõem o saldo. O sinal é definido pelo order_type: authorization soma como crédito; void e charge_back subtraem como débito. A disponibilidade versus o pendente é determinada pela payment_scheduled_at.

Subacquirer — reconciled_adjustment

Ajustes conciliados (subacquirer_reconciled_adjustment) aplicáveis às features suportadas, somados ao saldo.

Subacquirer — payment_batch

Lotes de pagamento (subacquirer_payment_batch) pendentes (status pending ou failed), somando o final_balance ao saldo.

Subacquirer — carry-forward

Saldo de arraste (subacquirer_balance): apenas o registro mais recente por (payment_method, payment_arrangement) é considerado, evitando duplicar históricos.