Este documento descreve o retorno esperado de uma chamada de API que gera uma transferência . Os dados de exemplo apresentados abaixo são fictícios e servem para ilustrar a estrutura e o significado de cada campo no retorno da resposta.
Exemplo de Retorno
{
"success": true,
"msg": "Transfer generated with success",
"body": {
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"original_amount": 120.75,
"status": "created",
"amount": 120.75,
"resource": "transfer",
"type": null,
"method": "p2p|pix|brcode|manual",
"reference_id": null,
"tax_value": 0,
"fees_client": 0,
"client": {
"id": "z9y8x7w6-v5u4-t3s2-r1q0-p9o8i7u6y5t4",
"taxpayer_id": "98765432100",
"name": "Maria Silva Oliveira"
},
"transaction": {
"id": "1a2b3c4d-5678-90ef-ghij-klmnopqrstuv",
"resource": "transfer",
"type": "p2p",
"end_to_end_id": null,
"amount": "120.7500",
"descripition": null,
"created_at": "2024-11-04T15:00:00.000000Z",
"updated_at": "2024-11-04T15:00:00.000000Z",
"description": null
},
"part_Key_id": null,
"part_name": "Fernando Lima Souza",
"part_taxpayer_id": "**\*.123.456-**",
"part_bank_name": "XYZBank",
"part_account_type": "checking",
"part_Branch_code": "1234",
"part_account_number": "567890123456",
"part_bank_code": "00123456",
"description": null,
"created_at": "2024-11-04 12:00:00",
"updated_at": "2024-11-04 12:00:00"
}
}
Campos Gerais
success: (boolean) Indica se a transferência foi gerada com sucesso.
msg: (string) Mensagem de retorno indicando o status da operação.
Estrutura do Corpo (body)
id: (string) Identificador único da transferência gerada.
original_amount: (int) Valor original da transferência antes de aplicação de taxas.
status: (string) Status atual da transferência, por exemplo, ‘created’.
Status Possíveis
created: A transferência foi criada e está aguardando processamento.
processing: A transferência está em andamento.
completed: A transferência foi concluída com sucesso.
failed: A transferência falhou.
canceled: A transferência foi cancelada.
amount: (int) Valor total da transferência após aplicação de taxas.
resource: (string) Tipo de recurso relacionado, neste caso, ‘transfer’.
type: (string | null) Tipo da transferência; pode ser nulo.
method: (string) Método de transferência utilizado, como ‘p2p’.
reference_id: (string | null) Identificador de referência, se aplicável.
tax_value: (float) Valor de taxas aplicadas à transferência.
fees_client: (float) Valor de taxas cobradas ao cliente.
Estrutura do Cliente (client)
id: (string) Identificador único do cliente.
taxpayer_id: (string) CPF ou CNPJ do cliente, sem formatação.
name: (string) Nome completo do cliente.
Detalhes da Transação (transaction)
id: (string) Identificador único da transação.
resource: (string) Tipo de recurso, como ‘transfer’.
type: (string) Tipo de transação, como ‘p2p’.
end_to_end_id: (string | null) Identificador end-to-end da transação.
amount: (string) Valor da transação em formato decimal.
descripition: (string | null) Descrição opcional da transação.
created_at: (string) Data e hora da criação da transação em formato ISO 8601.
updated_at: (string) Data e hora da última atualização da transação em formato ISO 8601.
description: (string | null) Campo descritivo adicional.
Detalhes da Contraparte
part_Key_id: (string | null) Identificador da chave da contraparte, se aplicável.
part_name: (string) Nome completo da contraparte.
part_taxpayer_id: (string) CPF ou CNPJ da contraparte com formatação parcial para fins de privacidade.
part_bank_name: (string) Nome do banco da contraparte.
part_account_type: (string) Tipo de conta da contraparte (e.g., ‘checking’).
part_Branch_code: (string) Código da agência bancária da contraparte.
part_account_number: (string) Número da conta da contraparte.
part_bank_code: (string) Código do banco da contraparte.
description: (string | null) Descrição opcional da transferência.
created_at: (string) Data e hora da criação do registro da transferência.
updated_at: (string) Data e hora da última atualização do registro da transferência.