Listar recebíveis

Endpoint: GET /unified/accounts/sellers/{sellers_pk}/receivables/

Autenticação: token JWT obrigatório. Superusuários ignoram a verificação de acesso. Usuários comuns só visualizam recebíveis cuja receiver_account ou acquirer_account esteja em seu conjunto de contas relacionadas.

Um recebível é um pagamento futuro de uma venda com cartão para o vendedor: cada parcela de uma transação de crédito gera um recebível, enquanto débito e PIX geram um único recebível. Este endpoint lista os recebíveis ordenados por expected_on decrescente, excluindo linhas com status == 'deleted'.

Parâmetros de caminho

string (uuid)

required

Identificador da conta unificada. São retornados recebíveis em que esta conta é receptora ou processadora.

Parâmetros de query

string

Busca textual sem distinção de maiúsculas/minúsculas nos campos acquirer_account.display_name, receiver_account.display_name, status e zoop_id.

string

Correspondência exata. Valores comuns: pending, paid, refunded, scheduled.

string (uuid)

Filtra pela conta unificada que recebe o valor.

string (uuid)

Filtra pela conta unificada que processou a transação.

string (uuid)

Filtra pela transação unificada que originou o recebível.

string

ISO-8601. Apenas recebíveis criados nesta data ou após.

string

ISO-8601. Limite superior inclusivo — o servidor adiciona 1 dia para cobrir o dia inteiro.

string

ISO-8601. Limite inferior para expected_on.

string

ISO-8601. Limite superior inclusivo (1 dia adicionado).

Resposta

Retorna um array de recebíveis.

string (uuid)

object | null

Projeção {id, display_name, type} da conta unificada que recebe o valor.

object | null

Projeção {id, display_name, type} da conta unificada que processou a venda.

string (uuid) | null

Identificador da transação unificada.

string

Um dos valores pending, paid, refunded, scheduled, deleted (linhas excluídas não aparecem na lista, mas podem aparecer no detalhe).

string

Valor líquido a receber, em BRL (em formato string, com . como separador decimal).

string

Valor bruto antes das taxas, em BRL.

string | null

Taxa de antecipação cobrada quando o recebível foi antecipado.

boolean

Indica se uma regra de split já foi aplicada a este recebível.

boolean | null

Indica se o recebível foi pago antecipadamente.

boolean | null

Indica se o vendedor é responsável em caso de disputa.

string | null

Número da parcela (ex.: "1" de 12). null para produtos sem parcelamento.

string | null

ISO-8601 se cancelado.

string | null

ISO-8601 do momento em que o recebível foi registrado.

string | null

ISO-8601 da transação originadora.

string | null

ISO-8601 do momento da liquidação.

string | null

ISO-8601 — dia previsto para a liquidação do recebível.

string | null

Identificador histórico do recurso na infraestrutura de processamento.

string

Estado reportado pela infraestrutura de processamento.

string | null

Data da última sincronização com a infraestrutura de processamento.

[
  {
    "id": "f3aa11b2-9c70-4f5b-8e21-12c8f7d9b1a2",
    "receiver_account": { "id": "9b1f0d2a-...", "display_name": "ACME Comércio LTDA", "type": "SELLER_PJ" },
    "acquirer_account": { "id": "9b1f0d2a-...", "display_name": "ACME Comércio LTDA", "type": "SELLER_PJ" },
    "transaction": "ab93c1c8-3c4a-4e0e-9d2a-7e6c11d2b3c4",
    "status": "pending",
    "amount": "97.50",
    "gross_amount": "100.00",
    "anticipation_fee": null,
    "has_split_linked": true,
    "prepaid": false,
    "liable": true,
    "installment": "1",
    "canceled_at": null,
    "created_at": "2025-05-10T13:20:11.000000Z",
    "transaction_created_at": "2025-05-10T13:19:50.000000Z",
    "paid_at": null,
    "expected_on": "2025-06-09T00:00:00.000000Z",
    "zoop_id": "rcv_a1b2c3",
    "zoop_acquirer_status": "PENDING",
    "zoop_last_updated": "2025-05-10T13:20:30.000000Z"
  }
]

Erros

Status	Quando
`401`	Token ausente ou inválido.
`403`	O chamador não possui acesso a `sellers_pk` nem às contas relacionadas.
`404`	`sellers_pk` inexistente.

Exemplos

curl "https://api.dlpay.cloud/unified/accounts/sellers/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/receivables/?status=pending&expected_on_gte=2025-06-01" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://api.dlpay.cloud/unified/accounts/sellers/{seller_id}/receivables/",
    headers={"Authorization": f"Bearer {access_token}"},
    params={"status": "pending", "expected_on_gte": "2025-06-01"},
)
receivables = response.json()

const url = new URL(`https://api.dlpay.cloud/unified/accounts/sellers/${sellerId}/receivables/`);
url.searchParams.set("status", "pending");
url.searchParams.set("expected_on_gte", "2025-06-01");
const response = await fetch(url, {
  headers: { Authorization: `Bearer ${accessToken}` },
});
const receivables = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Parâmetros de caminho

Parâmetros de query

Resposta

Erros

Exemplos

​Parâmetros de caminho

​Parâmetros de query

​Resposta

​Erros

​Exemplos

Parâmetros de caminho

Parâmetros de query

Resposta

Erros

Exemplos