Back to all

Conciliação

Hoje obtemos o relatório financeiro exportado no portal MyAccount, em CSV, com as movimentações e os saques/liquidações do período. Usamos esse relatório para a conciliação contábil mensal no nosso ERP. O processo exige acessar o portal manualmente, com login, reCAPTCHA e TOTP, em cada uma das 4 contas. Queremos substituí-lo por uma integração oficial e estável.

O que precisamos saber / solicitar

  1. A Yapay disponibiliza API oficial para obter o extrato financeiro (o mesmo conteúdo do relatório exportado no portal)? Se sim, enviar a documentação técnica.
  2. A autenticação pode ser por chave/token de API de longa duração (sem reCAPTCHA e sem TOTP interativo)? Como gerar e renovar esse token, e por conta ou por grupo?
  3. Existe ambiente de homologação com dados de teste para esse endpoint?

Dados que o endpoint precisa retornar (os que usamos hoje na conciliação):

  • Identificador único da transação (ID Transação)
  • Data da transação e data de liquidação/saque
  • Linhas de saque/liquidação (origem "Vindi Pagamentos") e seu identificador
  • Valor bruto e valor líquido por transação
  • Taxa de retenção e taxa de antecipação, separadas
  • Forma de pagamento (cartão, boleto, pix, TED)
  • Identificadores de fatura, cobrança e número do pedido
  • Tipo de operação (inclusive estornos)
  • Subsidiária/conta de origem

Requisitos técnicos

  • Filtro por período (data inicial e final) e paginação
  • Resposta em JSON ou CSV
  • Informar limites de requisições (rate limit) e a política de versionamento/mudança do contrato