📄 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)
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID único da transação no sistema. |
📊 Colunas Disponíveis (Transaction Object)
Abaixo estão todos os campos retornados no objeto de transação.
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID único da transação no sistema. |
txid | string | ID de transação (PIX ou Externo). |
endtoendid | string | Identificador End-to-End do PIX. |
value | decimal | Valor da transação. |
status | integer | Status da transação (1: Ativa, 0: Inativa/Pendente). |
description | string | Descrição ou observação da transação. |
datetime | timestamp | Data e hora em que a transação ocorreu. |
balance | decimal | Saldo da conta após a transação. |
bank_details | object | Dados bancários da transação (bank, agency, account). |
account | object | Dados da conta vinculada no sistema (id, name). |
type | object | Tipo da transação (id, name, description). |
payer | object | Dados do pagador (name, document, bank, agency, account). |
receiver | object | Dados do recebedor (name, document, bank, agency, account). |
created_by | object | Usuário que criou o registro (id, name). |
created_at | timestamp | Data de criação do registro. |
updated_at | timestamp | Data da última atualização. |
currency | string | Moeda da transação (ex: BRL). |
origin | string | Origem da transação (api, sicoob, sicredi, default). |
metadata | json | Dados 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ódigo | Descrição |
|---|---|
401 | Não Autorizado: Token ausente ou inválido. |
404 | Não Encontrado: Transação não existe ou foi excluída permanentemente. |