Dom Docs
Dom Pagamentos

Consultar uma transferência

GET/pixout/transfer/{batch_id}/{transfer_id}

Atualizado em · 1 min de leitura

Consulta os detalhes de uma transferência Pix individual

GET{apiUrl}/pixout/transfer/{batch_id}/{transfer_id}
URL base da API
Token de autenticação
Path Params
batch_idstringrequired

id do lote da transferência

transfer_idstringrequired

id da transferência

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

Choose an example:

application/json
Campos da resposta
transfer_idstring

UUID da transferência

statusstring

Status: pending, paid, failed

status_detailstring

Detalhe do status (preenchido em caso de erro)

namestring

Nome do recebedor

documentstring

CPF ou CNPJ do recebedor

pix_key_typestring

Tipo da chave Pix

pix_keystring

Chave Pix

external_referencestring

Referência externa

amountnumber

Valor da transferência

idempotency_keystring

Chave de idempotência

bank_receipt_urlstring

URL do comprovante bancário

paid_datestring

Data de pagamento (ISO 8601)

Esta página foi útil?