Skip to main content
Duas novidades nesta release: a antecipação avulsa ganhou um endpoint de listagem, e os recebedores passam a controlar se devem ser notificados quando ocorre um repasse.

Antecipação avulsa — listagem de antecipações

Até agora, consultar uma antecipação exigia guardar o id devolvido na simulação. Com o novo endpoint Listar antecipações, você consulta o histórico completo da sua conta em uma única chamada:
Pontos importantes do contrato:
  • A listagem é escopada pelo X-Client-Id, ou seja, devolve apenas as antecipações da sua conta.
  • Os resultados vêm da mais recente para a mais antiga.
  • A paginação usa page (padrão 1) e limit (padrão 10, máximo 100). Valores acima do máximo são limitados a 100.
  • Cada item traz exatamente os mesmos campos da consulta por identificador, incluindo a lista de recebíveis em items. Não é preciso consultar cada antecipação individualmente para ver os detalhes.
  • Simulações com status pending que já passaram do expiresAt são retornadas como expired, seguindo a mesma regra da consulta por identificador.
A resposta segue o envelope de listagem já usado na plataforma, com items e meta:
A antecipação avulsa segue em Beta. A funcionalidade está disponível para clientes habilitados, e detalhes da API podem evoluir nas próximas versões. Para habilitar sua conta, fale com o suporte pelo e-mail suporte@malga.io.

Recebedores — campo notifyOnPayout

Os endpoints de criação e de atualização de recebedor aceitam o novo campo booleano opcional notifyOnPayout, na raiz do corpo da requisição. Ele define se o recebedor deve ser notificado quando ocorre um repasse.
O comportamento padrão é notificar. Quem não quiser isso precisa desligar a notificação explicitamente:
  • Na criação: quando o campo é omitido, o recebedor é criado com notifyOnPayout igual a true.
  • Na atualização: quando o campo é omitido, o valor atual do recebedor é mantido. Uma atualização parcial que não cita a flag não religa a notificação de um recebedor configurado com false.
  • Nos recebedores existentes: todos passam a responder notifyOnPayout igual a true.
O campo também é devolvido nas respostas de criação, atualização, consulta por identificador e listagem de recebedores.
Features:
  1. Novo endpoint GET /v1/subacquirer/prepayment para listar as antecipações da conta, com paginação por page e limit
  2. Novo campo opcional notifyOnPayout em POST /v1/sellers e PATCH /v1/sellers/{id}
  3. Campo notifyOnPayout incluído nas respostas dos endpoints de recebedor
Ficou com dúvida? Fale com a gente pelo e-mail suporte@malga.io.