Recebíveis previstos por produto

Endpoint: GET /unified/accounts/sellers/{sellers_pk}/metrics/expectedreceivablesbyproduct/

Autenticação: JWT Bearer ou API Key. O usuário precisa ter acesso ao seller informado em sellers_pk.

Mesmos totais de recebíveis previstos do endpoint por data, adicionalmente segmentados por produto. A chave do produto é derivada de payment_type e installments da transação que originou o recebível:

Código do produto	Significado
`pix`	Transações por PIX.
`boleto`	Transações por boleto bancário.
`debit`	Transações no cartão de débito.
`credit_1`	Cartão de crédito, 1x (à vista).
`credit_2_6`	Cartão de crédito, de 2 a 6 parcelas.
`credit_7_12`	Cartão de crédito, de 7 a 12 parcelas.
`credit_13_21`	Cartão de crédito, de 13 a 21 parcelas.
`credit_22_plus`	Cartão de crédito, 22 ou mais parcelas.
`unknown`	Transação sem `payment_type` definido.

Limitado às 90 linhas mais recentes, ordenado por date decrescente.

Requisição

Parâmetros de caminho

string

required

UUID da conta unificada do seller.

Parâmetros de consulta

string (YYYY-MM-DD)

Limite inferior do intervalo de datas previstas (inclusivo).

string (YYYY-MM-DD)

Limite superior do intervalo de datas previstas (inclusivo).

Resposta

Um array JSON de objetos:

string

Categoria de produto — ver tabela acima.

string (YYYY-MM-DD)

Data prevista de liquidação.

integer

Soma dos valores previstos para a combinação produto/data, em centavos de BRL.

[
  { "product": "credit_2_6", "date": "2025-06-15", "total": 1200000 },
  { "product": "credit_1",   "date": "2025-06-15", "total":  300000 },
  { "product": "pix",        "date": "2025-06-14", "total":  150000 }
]

Erros

Status	Quando
`401`	Cabeçalho `Authorization` ausente ou inválido.
`403`	Autenticado, porém sem acesso ao seller informado em `sellers_pk`.
`404`	O UUID do seller não existe.

Exemplos

curl https://api.dlpay.cloud/unified/accounts/sellers/{sellers_pk}/metrics/expectedreceivablesbyproduct/ \
  -H "Authorization: Bearer $TOKEN"

import requests

response = requests.get(
    f"https://api.dlpay.cloud/unified/accounts/sellers/{sellers_pk}/metrics/expectedreceivablesbyproduct/",
    headers={"Authorization": f"Bearer {token}"},
)
rows = response.json()

const response = await fetch(
  `https://api.dlpay.cloud/unified/accounts/sellers/${sellersPk}/metrics/expectedreceivablesbyproduct/`,
  { headers: { Authorization: `Bearer ${token}` } },
);
const rows = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Recebíveis previstos por produto

Requisição

Parâmetros de caminho

Parâmetros de consulta

Resposta

Erros

Exemplos

​Requisição

​Parâmetros de caminho

​Parâmetros de consulta

​Resposta

​Erros

​Exemplos

Requisição

Parâmetros de caminho

Parâmetros de consulta

Resposta

Erros

Exemplos