Extrato de Recebíveis

O Extrato de Recebíveis é o endpoint responsável por exibir o detalhamento das movimentações que ocorrem dentro do módulo de recebíveis (subadquirência), como recebimentos de cartão de crédito e débito, tarifas, descontos, estornos e chargebacks.

Esse extrato não deve ser confundido com o extrato da conta BaaS. São dois recursos com finalidades distintas:

Em outras palavras, o extrato da conta BaaS mostra o resultado (o saldo que chegou na conta), enquanto o Extrato de Recebíveis mostra a origem desse resultado (o que gerou aquele saldo).

Regra de Negócio

Ao longo do dia, a Celcoin realiza operações de consolidação do saldo disponível na conta de recebíveis do cliente, transferindo esse saldo para a conta BaaS correspondente.

Alguns pontos importantes sobre esse fluxo:

• Essas movimentações chegam na conta BaaS com o movement type Transferência Interna. É assim que o valor aparecerá no extrato da conta BaaS.
• Esse comportamento é o mesmo independentemente de a transação de origem ser uma transação de split ou não.
• A transferência do saldo consolidado para a conta BaaS é realizada às 12h e às 19h.

Para entender o que compôs esse valor consolidado, o cliente consulta o Extrato de Recebíveis, que traz o detalhamento de cada movimentação individual através do campo friendlyDescriptor.

Exemplo de Request

Modelo de requisição:

curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/companies/4960944/extract?dateFrom=2026-06-01&dateTo=2026-06-30' \
--header 'Authorization: Bearer <TOKEN>'

Campos do Request

Exemplo de Response

Sucesso (200):

{
    "version": "1.0.0",
    "status": 200,
    "body": {
        "Balances": [
            {
                "transactionId": "TXN-2026-000123",
                "value": 1500.00,
                "friendlyDescription": "Crédito de recebíveis",
                "details": [
                    {
                        "value": 800.00,
                        "friendlyDescription": "Parcela 1/2"
                    },
                    {
                        "value": 700.00,
                        "friendlyDescription": "Parcela 2/2"
                    }
                ]
            },
            {
                "transactionId": "TXN-2026-000124",
                "value": -50.00,
                "friendlyDescription": "Taxa de serviço",
                "details": []
            }
        ],
        "Totals": {
            "enabled": 4320.75
        }
    }
}

Campos do Response

Possíveis Responses

Erro status code 401:

{
    "version": "1.0.0",
    "status": 401,
    "error": {
        "errorCode": "UNAUTHORIZED",
        "message": "Credenciais inválidas ou ausentes."
    }
}

Erro status code 422:

{
    "version": "1.0.0",
    "status": 422,
    "error": {
        "errorCode": "VALIDATION_ERROR",
        "message": "The given data was invalid.",
        "errors": {
            "dateFrom": [
                "O parâmetro \"dateFrom\" é obrigatório."
            ]
        }
    }

{
    "version": "1.0.0",
    "status": 422,
    "error": {
        "errorCode": "VALIDATION_ERROR",
        "message": "The given data was invalid.",
        "errors": {
            "dateTo": [
                "A data inicial não pode ser maior que a data final."
            ]
        }
    }
}

Significado de Cada Possível friendlyDescription

O campo friendlyDescriptor indica a natureza da movimentação retornada no extrato de recebíveis. Abaixo estão os padrões possíveis e o que cada um representa.

Cartão (subadquirência, sem split)

Split (master ou subconta)

Nesses casos, {meio} representa o meio de pagamento utilizado, por exemplo Cartão de Crédito, e {companyId} identifica a subconta envolvida na movimentação.

Transferência interna (crédito consolidado na conta BaaS)

Esses descritores aparecem no extrato da conta BaaS, referentes ao crédito do saldo consolidado de recebíveis na conta do cliente.