Consultar o lote | Dom Docs

GET{apiUrl}/pixout/transfer/{batch_id}

URL base da API

Token de autenticação

Path Params

batch_idstringrequired

id do lote da transferência

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

Response

Choose an example:

application/json

Campos da resposta

batch_idstring

UUID do lote

descriptionstring

Descrição do lote

created_atstring

Data de criação (ISO 8601)

postbackUrlstring

URL de postback configurada

total_grossnumber

Valor bruto total do lote

total_transfernumber

Valor líquido total transferido

total_feenumber

Total de taxas cobradas

receiversarray

Lista de transferências do lote

receivers[].transfer_idstring

UUID da transferência

receivers[].statusstring

Status: pending, paid, error

receivers[].status_detailstring

Detalhe do status (preenchido em caso de erro)

receivers[].namestring

Nome do recebedor

receivers[].documentstring

CPF ou CNPJ do recebedor

receivers[].pix_key_typestring

Tipo da chave Pix

receivers[].pix_keystring

Chave Pix

receivers[].external_referencestring

Referência externa

receivers[].amountnumber

Valor da transferência

receivers[].idempotency_keystring

Chave de idempotência

receivers[].bank_receipt_urlstring

URL do comprovante bancário

receivers[].paid_datestring

Data de pagamento (ISO 8601)