Consultar uma transferência

GEThttps://{apiUrl}/pixout/transfer/{batch_id}/{transfer_id}

Atualizado em 21 de janeiro de 2025 · 2 min de leitura

Endpoint: GET https://{apiUrl}/pixout/transfer/{batch_id}/{transfer_id}

Consulta os detalhes de uma transferência PIX individual.

Parâmetros

GEThttps://{apiUrl}/pixout/transfer/{batch_id}/{transfer_id}

URL base da API

Token de autenticação

Path Params

batch_idstringrequired

Identificador único do lote (UUID)

transfer_idstringrequired

Identificador único da transferência (UUID)

curl --request GET \
  --url "https://{apiUrl}/pixout/transfer/{batch_id}/{transfer_id}"

Response

Choose an example:

application/json

Status possíveis

Status	Descrição
`pending`	Transferência aguardando processamento
`processing`	Transferência em processamento pelo banco
`done`	Transferência concluída com sucesso
`error`	Falha no processamento — pode ser editada e reenviada

Exemplo de resposta

json

{
  "id": "transferencia-uuid-aqui",
  "batch_id": "lote-uuid-aqui",
  "status": "done",
  "value": 150.00,
  "key": "joao@exemplo.com",
  "key_type": "EMAIL",
  "name": "João da Silva",
  "document": "11111111111",
  "created_at": "2024-10-01T15:36:00Z"
}

Campos da resposta

idstring

UUID da transferência

batch_idstring

UUID do lote ao qual esta transferência pertence

statusstring

Estado: pending, processing, done ou error

valuefloat

Valor transferido em reais

keystring

Chave Pix do destinatário

key_typestring

Tipo da chave: CPF, CNPJ, EMAIL, PHONE ou EVP

namestring

Nome do destinatário

documentstring

CPF ou CNPJ do destinatário

created_atstring

Data de criação no formato ISO 8601

Esta página foi útil?