Skip to content

📄 Detalhar Transação

Retorna o perfil completo de uma única transação, incluindo dados de auditoria, pagador, recebedor e divisões de pagamento.

Endpoint: GET /backoffice/transactions/\{id\}


📥 Parâmetros de Entrada (Path)

CampoTipoDescrição
idintegerID único da transação no sistema.

📊 Colunas Disponíveis (Transaction Object)

Abaixo estão todos os campos retornados no objeto de transação.

CampoTipoDescrição
idintegerID único da transação no sistema.
txidstringID de transação (PIX ou Externo).
endtoendidstringIdentificador End-to-End do PIX.
valuedecimalValor da transação.
statusintegerStatus da transação (1: Ativa, 0: Inativa/Pendente).
descriptionstringDescrição ou observação da transação.
datetimetimestampData e hora em que a transação ocorreu.
balancedecimalSaldo da conta após a transação.
bank_detailsobjectDados bancários da transação (bank, agency, account).
accountobjectDados da conta vinculada no sistema (id, name).
typeobjectTipo da transação (id, name, description).
payerobjectDados do pagador (name, document, bank, agency, account).
receiverobjectDados do recebedor (name, document, bank, agency, account).
created_byobjectUsuário que criou o registro (id, name).
created_attimestampData de criação do registro.
updated_attimestampData da última atualização.
currencystringMoeda da transação (ex: BRL).
originstringOrigem da transação (api, sicoob, sicredi, default).
metadatajsonDados técnicos adicionais em formato JSON.

📤 Retorno de Sucesso (200 OK)

json
{
    "data": {
        "id": 1,
        "txid": "E123456789...",
        "endtoendid": "E123456789...",
        "value": 1500.00,
        "status": 1,
        "description": "Pagamento de faturas",
        "datetime": "2024-04-20 12:00:00",
        "balance": 5000.00,
        "bank_details": {
            "bank": "001",
            "agency": "1234",
            "account": "567890"
        },
        "account": { "id": 10, "name": "Conta Exemplo" },
        "type": { "id": 1, "name": "PIX_IN", "description": "Entrada de Pix" },
        "payer": {
            "name": "Empresa A",
            "document": "00000000000191",
            "bank": "Banco Teste",
            "agency": "0001",
            "account": "112233"
        },
        "receiver": {
            "name": "Usuario B",
            "document": "11111111111",
            "bank": "FastGiveMoney",
            "agency": "0001",
            "account": "445566"
        },
        "created_by": { "id": 5, "name": "Admin" },
        "created_at": "2024-04-20 12:00:00",
        "updated_at": "2024-04-20 12:05:00",
        "currency": "BRL",
        "metadata": null
    }
}

❌ Erros Comuns

CódigoDescrição
401Não Autorizado: Token ausente ou inválido.
404Não Encontrado: Transação não existe ou foi excluída permanentemente.

FastGivr API Documentation