Logo

Transferências Internas

Consultar Transferência Interna

GET/v1/internal-transfer/:transfer_id

Retorna os detalhes de uma transferência interna específica. Apenas o remetente pode consultar suas próprias transferências.

Parâmetros de URL

CampoTipoDescrição
transfer_idobrigatório
string (UUID)ID único da transferência retornado na criação.

Campos da Resposta

CampoTipoDescrição
id
string (UUID)ID único da transferência
from_account_id
stringID da conta remetente
to_account_id
stringID da conta destinatária
to_account_email
stringEmail da conta destinatária
amount
numberValor bruto transferido
fee
numberTaxa cobrada na operação
net_amount
numberValor líquido creditado ao destinatário
status
stringCOMPLETED | PENDING | FAILED
metadata
objectMetadados adicionais da transferência
created_at
string (ISO 8601)Data e hora de criação
updated_at
string (ISO 8601)Data e hora da última atualização

Status da Transferência

COMPLETEDTransferência concluída com sucesso
PENDINGTransferência em processamento
FAILEDTransferência falhou

Erros Possíveis

400

ID da transferência inválido ou ausente

401

Não autenticado

403

Você não tem permissão para acessar esta transferência (apenas o remetente pode consultar)

404

Transferência não encontrada

  • "Transferência interna não encontrada"
  • "Usuário não encontrado"
GEThttps://api.connectpay.vc/v1/internal-transfer/{transfer_id}
Headers
api-secret: sua-api-secret-aqui
cURL
curl -X GET "https://api.connectpay.vc/v1/internal-transfer/550e8400-e29b-41d4-a716-446655440000" \
  -H "api-secret: sua-api-secret-aqui"
Response 200
{
  "hasError": false,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "from_account_id": "user-123",
    "to_account_id": "user-456",
    "to_account_email": "destinatario@example.com",
    "amount": 100.50,
    "fee": 2.50,
    "net_amount": 100.50,
    "status": "COMPLETED",
    "metadata": {},
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T10:30:00.000Z"
  }
}