Consultar Transferência Pix

Retorna os detalhes de uma transferência Pix. Para fazê-lo deve ser efetuada a chamada para o serviço de consulta de transferências, enviando como parâmetros o identificador único (id).

Request

A chamada deverá ser feita utilizando o método GET.

URL

{BaseUrl}/api/v1/pix/transfers/{id}

HTTP Headers - Exemplo:

Authorization: Basic {base64(client_id:client_secret)}
Content-Type: application/json

O parâmetro {id} pode ser:

• transfer_id - ID interno da transferência
• client_ref - Referência externa informada na criação

A busca é feita primeiro pelo transfer_id; caso nenhuma transferência seja encontrada, o valor é buscado como client_ref.

Exemplo cURL - bash – Por transfer_id:

curl -X GET "https://api.moneyguard.com.br/api/v1/pix/transfers/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer seu_access_token"

Exemplo cURL - bash – Por client_ref:

curl -X GET "https://api.moneyguard.com.br/api/v1/pix/transfers/PAG-67890" \
    -H "Authorization: Bearer seu_access_token" \
    -H "User-Agent: seu_user_agent"

Response

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo

{
        "transfer_id": "7c1e0947-620e-42fc-bdcc-efbd62dd5c66",
        "client_ref": "saque_82909",
        "amount": 10,
        "status": "completed",
        "recipient_name": "John Doe",
        "recipient_tax_id": "33858304892",
        "pix_key": "33759504892",
        "pix_key_type": "cpf",
        "e2e_id": "E5382211620269olNsA5qf2Do",
        "failure_reason": null,
        "processed_at": "2026-01-28T15:39:35.469-03:00"
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
transfer_id (Obrigatório)	Código único da transferência	STRING limite de 100 caracteres
client_ref (Opcional)	Referência externa informada na criação	STRING limite de 100 caracteres
amount (Obrigatório)	Valor da transferência, em reais	DECIMAL Maior que zero
status (Obrigatório)	Status da transferência	ENUM pending (Transferência criada, aguardando processamento) sending (Transferência em processamento) completed (Transferência realizada com sucesso) canceled (Transferência cancelada ou rejeitada — ver failure_reason) refunded (Transferência devolvida integralmente) partially_refunded (Transferência devolvida parcialmente)
recipient_name (Obrigatório)	Nome do destinatário	STRING limite de 100 caracteres
recipient_tax_id (Obrigatório)	Documento do destinatário	STRING limite de 14 caracteres
pix_key (Obrigatório)	Chave PIX do destinatário	STRING limite de 100 caracteres
pix_key_type (Obrigatório)	Tipo da chave PIX	ENUM cpf (11 dígitos numéricos - 12345678901) cnpj (14 dígitos numéricos - 12345678000190) phone (+55 + DDD + número - +5511999998888) email (e-mail válido - pagamentos@empresa.com) evp (UUID (chave aleatória) -a1b2c3d4-e5f6-7890-abcd-1234567890ab)
e2e_id (Opcional)	ID End-to-End do BACEN (quando pago)	STRING limite de 32 caracteres
failure_reason (Opcional)	Motivo da falha (quando falhou ou cancelado)	STRING limite de 100 caracteres
processed_at (Opcional)	Data/hora da última atualização	STRING formato datetime YYYY-mm-ddTHH:MM:ss. z

Error

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.

HTTP 404 Response Body - Exemplo

{
    "error": "PIX transfer not found"
}