> ## 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.

# Abr 30, 2026 - APIs de payouts, salesPlanId em Sellers e totalPaidAmount na Analytics API

> Novas APIs de saldo, repasses e ordens de pagamento, campo novo na criação de seller e novo campo totalPaidAmount disponível na query allCharges da Analytics API

export const AuthorProfile = ({author}) => <div className="flex flex-row gap-3 items-center">
    {author.image && <img src={author.image} className="w-10 h-10 rounded-full m-0" />}
    <div>
      <a href={author.url}>{author.name}</a>
      <br />
      <span>{author.title}</span>
    </div>
  </div>;

export const joaov = {
  name: "João Victor",
  title: "Data Engineer",
  url: "https://github.com/jvdrip",
  image: "https://github.com/jvdrip.png"
};

export const leozera = {
  name: "Leonardo Pinheiro",
  title: "Tech Lead",
  url: "https://github.com/0xleozera",
  image: "https://github.com/0xleozera.png"
};

<div className="flex flex-row gap-4">
  <AuthorProfile author={leozera} />

  <AuthorProfile author={joaov} />
</div>

## Novas APIs de saldo, repasses e ordens de pagamento, campo novo na criação de seller

Adicionamos uma nova seção na **Referência da API**: a [Payouts](/api-reference/payouts/consultar-saldo-de-payouts), pensada para te dar visibilidade total sobre saldos, repasses e ordens de pagamento da nossa subadquirente, tudo em um só lugar.

Além disso, agora na [criação de seller](/api-reference/sellers/criacao-de-um-novo-recebedor) adicionamos o campo opcional `salesPlanId`, que é um identificador do **Plano de Venda na Zoop**, usado para amarrar o seller a um plano comercial de vendas específico.

### Novos endpoints de Payouts

* `GET /v1/payouts/balance`: saldo disponível e a receber.
* `GET /v1/payouts/payment-batches`: listagem paginada de repasses.
* `GET /v1/payouts/payment-batches/{id}`: detalhe de um repasse.
* `GET /v1/payouts/payment-batches/{id}/orders`: ordens de pagamento que compõem um repasse.
* `GET /v1/payouts/orders`: listagem paginada de ordens de pagamento.
* `GET /v1/payouts/orders/{id}`: detalhe de uma ordem de pagamento.

### Como usar

Consultar o saldo disponível e a receber:

```bash theme={null}
curl --location 'https://api.malga.io/v1/payouts/balance' \
  --header 'X-Client-Id: YOUR_CLIENT_ID' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

Listar repasses:

```bash theme={null}
curl --location 'https://api.malga.io/v1/payouts/payment-batches' \
  --header 'X-Client-Id: YOUR_CLIENT_ID' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

Filtrar ordens de pagamento por cobrança:

```bash theme={null}
curl --location 'https://api.malga.io/v1/payouts/orders?chargeId=YOUR_CHARGE_ID' \
  --header 'X-Client-Id: YOUR_CLIENT_ID' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

Aproveite para dar uma olhada na [referência completa](/api-reference/payouts/consultar-saldo-de-payouts) e levar a conciliação financeira do seu negócio para o próximo nível 🚀

## Novo campo totalPaidAmount na Analytics API

Disponibilizamos o campo `totalPaidAmount` nas queries `allCharges` e `charge` da [Analytics API](/analytics/intro). Esse campo representa o valor total efetivamente pago na transação, incluindo eventuais taxas que possam ter sido repassadas ao pagador.

Esse cenário acontece no **Mercado Pago**, onde as taxas podem ser assumidas pelo cliente final, e não pelo lojista. Nesses casos, o valor pago pelo cliente pode ser maior do que o valor original da cobrança (`amount`).

Com o `totalPaidAmount`, você consegue:

* Ter maior precisão na análise do valor pago pelo cliente final
* Diferenciar o valor da cobrança do valor efetivamente desembolsado

**Importante**: O campo `totalPaidAmount` não se aplica a todos os provedores ou transações e será preenchido apenas em cenários específicos do **Mercado Pago** nos quais exista diferença entre o valor da cobrança e o valor efetivamente pago, como nos casos em que o cliente assume as taxas. Em geral, esse campo é populado exclusivamente quando o provedor retorna o valor com juros aplicados; para demais provedores ou transações sem juros ao comprador, permanecerá vazio.

Confira em nossa [documentação](/analytics/queries/charges) os detalhes do campo e as demais informações retornadas pela query.

<Tip>
  Features:

  1. Nova seção Payouts no API Reference com 6 endpoints
  2. Consulta de saldo, repasses e ordens de pagamento em um único lugar
  3. Filtros por seller, status e intervalo de datas
  4. Novo campo opcional `salesPlanId` na criação de seller (provedor Zoop)
  5. É possível testar a query [allCharges](/analytics/queries/charges) e a Analytics API através do playground disponível neste [link](https://graphql.malga.io/), utilizando suas credenciais de acesso à Malga.
</Tip>

Até a próxima! 🚀