Lançamentos Futuros

Esta rota retorna uma visão consolidada dos valores de recebíveis futuros, agrupados por datas e períodos (7, 15, 30 dias e meses), permitindo ao parceiro projetar o fluxo de caixa com base nos lançamentos já previstos no sistema Paytime.

🔽

GET urlServidor/v1/marketplace/transactions/future_releases

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Headers

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken de autenticação. Pode ser encontrado em nosso portal na guia de integração.
AuthorizationAuth Type Bearer TokenSimInserir o Bearer Token, gerado na rota Auth
establishment_idstringSimID do estabelecimento ao qual os lançamentos estão vinculados.

Exemplo de header da requisição

curl--request GET \
--location '/v1/marketplace/transactions/future\_releases\_daily' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \
--header 'establishment_id: your_establishment_id' \

📎 Query Parameters

NomeTipoDescrição
filtersstringJSON com filtros (opcional). Campos filtráveis: gateway_authorization, expected_on.

Exemplo de Response de sucesso.

{
  "calendar": [
    {
      "amount": 100000,
      "date": "2025-07-01"
    }
  ],
  "sevenDays": {
    "amount": 300000
  },
  "fifteenDays": {
    "amount": 500000
  },
  "thirtyDays": {
    "amount": 800000
  },
  "months": [
    {
      "amount": 2000000,
      "year": 2025,
      "month": 7
    }
  ],
  "total": {
    "amount": 5000000
  }
}

📑 Tabela de Campos do Response

CampoTipoObrigatórioDescrição
calendararraySimLista de valores previstos por data. Cada item detalha o valor total previsto em determinada data.
calendar[].amountnumberSimValor previsto em centavos para a data especificada.
calendar[].datestringSimData prevista para o lançamento (formato YYYY-MM-DD).
sevenDaysobjectSimTotal consolidado de valores previstos para os próximos 7 dias.
sevenDays.amountnumberSimValor total (em centavos) previsto para os próximos 7 dias.
fifteenDaysobjectSimTotal consolidado de valores previstos para os próximos 15 dias.
fifteenDays.amountnumberSimValor total (em centavos) previsto para os próximos 15 dias.
thirtyDaysobjectSimTotal consolidado de valores previstos para os próximos 30 dias.
thirtyDays.amountnumberSimValor total (em centavos) previsto para os próximos 30 dias.
monthsarraySimLista de valores agrupados por mês/ano.
months[].amountnumberSimValor total (em centavos) previsto para o mês especificado.
months[].yearnumberSimAno do agrupamento.
months[].monthnumberSimMês do agrupamento (1 a 12).
totalobjectSimValor total global previsto considerando todos os lançamentos futuros cadastrados.
total.amountnumberSimValor total previsto em centavos.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.


Did this page help you?