<aside> <img src="/icons/map-pin_blue.svg" alt="/icons/map-pin_blue.svg" width="40px" />
</aside>
Esse endpoint possui como objetivo o envio de dados para a análise de pré-aprovação e oferta. Assim, ele pode ser usado tanto para adicionar um histórico de pagamentos quanto atualizar os já existentes.
https://{BASE_URL}/upload_external_data
Content-Type: application/jsonAuthorization: Bearer {token}Version: v1Tamanho Máximo: O corpo da requisição não deve exceder 30MB. Caso ultrapasse, um erro será retornado;
Validação de Dados: Se qualquer campo estiver inadequado ou com formatação incorreta, a requisição será abortada integralmente;
Billing: Em um objeto de billing, o campo reference_month deve ser único (perante os demais objetos de um mesmo contrato). Assim, este deve ser utilizado como chave para atualizações do pagamento. Caso múltiplas transações tenham sido realizadas, de um mesmo contrato, em um mesmo mês, o objeto (billing) deve conter um agregado dessas, conforme descrito na coluna observação de cada campo ali presente. Abaixo, segue o exemplo de 5 pagamentos realizados no mês de Janeiro, para um mesmo contrato.
{
"reference_month": "2025-01",
"due_date": "2025-01-15",
"paid_at": "2025-03-01 12:00:00 -0300",
"status": "paid",
"liquid_amount": 2000.0,
"nominal_amount": 2500.0,
"is_platform_processed": true
}
Vale enfatizarque, para pagamentos em atraso, caso seja emitida uma nova cobrança, o due_date deve ser atualizado, assim como paid_at e status, caso tenham sido pagos.
Em caso de sucesso, a resposta terá o seguinte formato:
Response OK:
{
"message": "success"
}